@corti/sdk 3.1.0-rc → 3.1.0-rc.2

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@corti/sdk",
-        "X-Fern-SDK-Version": "3.1.0-rc",
-        "User-Agent": "@corti/sdk/3.1.0-rc",
+        "X-Fern-SDK-Version": "3.1.0-rc.2",
+        "User-Agent": "@corti/sdk/3.1.0-rc.2",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "Tenant-Name": options === null || options === void 0 ? void 0 : options.tenantName,

package/dist/cjs/api/resources/documents/resources/sections/client/Client.d.ts

@@ -14,6 +14,9 @@ export declare class SectionsClient {
     constructor(options: SectionsClient.Options);
     get versions(): VersionsClient;
     /**
+     * Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content.
+     * Use query parameters to filter by language, region, specialty, label, publish status, or source.
+     *
      * @param {Corti.documents.GuidedSectionsListRequest} request
      * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -78,6 +81,9 @@ export declare class SectionsClient {
     delete(sectionID: string, requestOptions?: SectionsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
+     * Updates the section's metadata fields (name, description, languages, regions, specialties, labels).
+     * Generation content (instructions, output schema) is managed through versions and cannot be updated here.
+     *
      * @param {string} sectionID
      * @param {Corti.documents.GuidedSectionsUpdateRequest} request
      * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/documents/resources/sections/client/Client.js

@@ -61,6 +61,9 @@ class SectionsClient {
         return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new Client_js_1.VersionsClient(this._options)));
     }
     /**
+     * Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content.
+     * Use query parameters to filter by language, region, specialty, label, publish status, or source.
+     *
      * @param {Corti.documents.GuidedSectionsListRequest} request
      * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -315,6 +318,9 @@ class SectionsClient {
         });
     }
     /**
+     * Updates the section's metadata fields (name, description, languages, regions, specialties, labels).
+     * Generation content (instructions, output schema) is managed through versions and cannot be updated here.
+     *
      * @param {string} sectionID
      * @param {Corti.documents.GuidedSectionsUpdateRequest} request
      * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/documents/resources/templates/client/Client.d.ts

@@ -14,6 +14,9 @@ export declare class TemplatesClient {
     constructor(options: TemplatesClient.Options);
     get versions(): VersionsClient;
     /**
+     * Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections.
+     * Use query parameters to filter by language, region, specialty, label, publish status, or source.
+     *
      * @param {Corti.documents.GuidedTemplatesListRequest} request
      * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -74,6 +77,10 @@ export declare class TemplatesClient {
     delete(templateID: string, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
+     * Updates the template's metadata fields (name, description, languages, regions, specialties, labels).
+     * Generation content (template instructions, section composition) is managed through versions
+     * and cannot be updated here.
+     *
      * @param {string} templateID
      * @param {Corti.documents.GuidedTemplatesUpdateRequest} request
      * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/documents/resources/templates/client/Client.js

@@ -61,6 +61,9 @@ class TemplatesClient {
         return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new Client_js_1.VersionsClient(this._options)));
     }
     /**
+     * Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections.
+     * Use query parameters to filter by language, region, specialty, label, publish status, or source.
+     *
      * @param {Corti.documents.GuidedTemplatesListRequest} request
      * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -311,6 +314,10 @@ class TemplatesClient {
         });
     }
     /**
+     * Updates the template's metadata fields (name, description, languages, regions, specialties, labels).
+     * Generation content (template instructions, section composition) is managed through versions
+     * and cannot be updated here.
+     *
      * @param {string} templateID
      * @param {Corti.documents.GuidedTemplatesUpdateRequest} request
      * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/documents/resources/templates/resources/versions/client/Client.d.ts

@@ -11,6 +11,9 @@ export declare class VersionsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<VersionsClient.Options>;
     constructor(options: VersionsClient.Options);
     /**
+     * Returns raw authored template versions without inheritance resolution or section expansion.
+     * To see resolved content, use GET /documents/templates/{templateID} instead.
+     *
      * @param {string} templateID
      * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -39,6 +42,9 @@ export declare class VersionsClient {
     create(templateID: string, request: Corti.documents.templates.GuidedTemplatesCreateVersionRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedShallowTemplateVersionResponse>;
     private __create;
     /**
+     * Returns the raw authored template version without inheritance resolution or section expansion.
+     * To see resolved content, use GET /documents/templates/{templateID} instead.
+     *
      * @param {string} templateID
      * @param {string} versionID
      * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/documents/resources/templates/resources/versions/client/Client.js

@@ -56,6 +56,9 @@ class VersionsClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
+     * Returns raw authored template versions without inheritance resolution or section expansion.
+     * To see resolved content, use GET /documents/templates/{templateID} instead.
+     *
      * @param {string} templateID
      * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -180,6 +183,9 @@ class VersionsClient {
         });
     }
     /**
+     * Returns the raw authored template version without inheritance resolution or section expansion.
+     * To see resolved content, use GET /documents/templates/{templateID} instead.
+     *
      * @param {string} templateID
      * @param {string} versionID
      * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/transcripts/client/Client.d.ts

@@ -29,7 +29,7 @@ export declare class TranscriptsClient {
     list(id: Corti.Uuid, request?: Corti.TranscriptsListRequest, requestOptions?: TranscriptsClient.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsListResponse>;
     private __list;
     /**
-     * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>Requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. In the latter scenario, a partial or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the completed transcript.<br/><br/>The client can poll the `/transcripts` endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status monitoring:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript request (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
+     * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the `async` parameter to true to receive the location header immediately and process the request asynchronously. Read more [here](https://docs.corti.ai/stt/transcripts).</Note>
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request

package/dist/cjs/api/resources/transcripts/client/Client.js

@@ -142,7 +142,7 @@ class TranscriptsClient {
         });
     }
     /**
-     * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>Requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. In the latter scenario, a partial or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the completed transcript.<br/><br/>The client can poll the `/transcripts` endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status monitoring:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript request (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
+     * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the `async` parameter to true to receive the location header immediately and process the request asynchronously. Read more [here](https://docs.corti.ai/stt/transcripts).</Note>
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request

package/dist/cjs/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts

@@ -11,7 +11,7 @@ export interface TranscriptsCreateRequest {
     recordingId: Corti.Uuid;
     /** The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more. */
     primaryLanguage: string;
-    /** Indicates whether spoken dictation commands should be converted to punctuation (e.g., 'comma' → ','). */
+    /** If true, spoken punctuation will be converted to symbols (e.g., 'comma' → ','). */
     isDictation?: boolean;
     /** If true, each audio channel is transcribed separately. */
     isMultichannel?: boolean;
@@ -19,4 +19,6 @@ export interface TranscriptsCreateRequest {
     diarize?: boolean;
     /** An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true */
     participants?: Corti.TranscriptsParticipant[];
+    /** If true, the request will return immediately with a 202 status and the transcript will be processed asynchronously. Poll [Get Transcript Status](/api-reference/transcripts/get-transcript-status) to check transcript processing status - `processing`, `completed`, `failed`. */
+    async?: boolean;
 }

package/dist/cjs/api/types/GuidedArrayNode.d.ts

@@ -1,10 +1,11 @@
 import type * as Corti from "../index.js";
 export interface GuidedArrayNode {
     type: "array";
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description?: string;
+    /** Must be another output schema node (string, number, boolean, array, or object). */
     items: Corti.GuidedOutputSchema;
-    /** Controls how each array item is rendered in the generated output. Use `bullet` (default), `numbered`, or `plain`, or provide a custom format string containing the `{item}` placeholder. */
+    /** Format string used to render each array item in the generated output. Use the `{item}` placeholder for the item value. */
     itemFormat?: string;
     /** Minimum number of array items to generate. */
     minItems?: number | null;

package/dist/cjs/api/types/GuidedBoolNode.d.ts

@@ -1,7 +1,7 @@
 export interface GuidedBoolNode {
     type: "boolean";
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description?: string;
-    /** The default to output if nothing to output. */
+    /** If nothing is outputted, this default is used. */
     default?: boolean | null;
 }

package/dist/cjs/api/types/GuidedDocumentsGenerateBase.d.ts

@@ -9,4 +9,6 @@ export interface GuidedDocumentsGenerateBase {
     context?: Corti.GuidedDocumentContext[];
     /** When supplied, all facts and transcripts already attached to the referenced interaction are passed implicitly as input context. Facts with `isDiscarded: true` are not passed on. */
     interactionId?: string;
+    /** Key/value labels attached to the document. Used for filtering in the LIST /documents endpoint. */
+    labels?: Corti.GuidedLabel[];
 }

package/dist/cjs/api/types/GuidedEphemeralDocument.d.ts

@@ -1,3 +1,4 @@
+import type * as Corti from "../index.js";
 /**
  * A generated document that was not saved to the database.
  */
@@ -7,6 +8,10 @@ export interface GuidedEphemeralDocument {
     templateVersionId: string;
     /** The BCP 47 language tag of the generated output. */
     language: string;
+    /** The interaction whose context was used to generate this document, if supplied. */
+    interactionId?: string | null;
     stringDocument: Record<string, string>;
     structuredDocument?: Record<string, unknown> | null;
+    /** Key/value labels attached to this document. */
+    labels: Corti.GuidedLabel[];
 }

package/dist/cjs/api/types/GuidedFieldDefinition.d.ts

@@ -2,7 +2,10 @@ import type * as Corti from "../index.js";
 export interface GuidedFieldDefinition {
     /** Use to set a key to reference. */
     key: string;
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description: string;
+    /** Must be another output schema node (string, number, boolean, array, or object). */
     value: Corti.GuidedOutputSchema;
+    /** If nothing is outputted for this field, this default value is used in the rendered output. */
+    default?: string | null;
 }

package/dist/cjs/api/types/GuidedNumberNode.d.ts

@@ -1,10 +1,10 @@
 export interface GuidedNumberNode {
     type: "number";
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description?: string;
-    /** The default to output if nothing to output. */
+    /** If nothing is outputted, this default is used. */
     default?: number | null;
-    /** Can be used to prompt the LLM for specifically allowed numeric values to output. */
+    /** Can be used to guide the LLM with specific values to output. */
     enum?: number[];
     /** Use if a minimum value applies. */
     minimum?: number | null;

package/dist/cjs/api/types/GuidedObjectNode.d.ts

@@ -1,14 +1,14 @@
 import type * as Corti from "../index.js";
 export interface GuidedObjectNode {
     type: "object";
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description?: string;
     /**
      * Free-form format string that controls how an object's fields are rendered into the final text output. Operates in one of two modes determined by which placeholders appear:
      *
-     * **Subheading mode** (default: `"{key}: {value}\n"`): triggered when the format contains both `{key}` and `{value}`. Applied per field — each field becomes a key/value line. Fields that render to null are skipped.
+     * **Subheading mode** (default: `"{key}: {value}\n"`): triggered when the format contains both `{key}` and `{value}`. Applied per field — each field becomes a key/value line. When a field has no relevant input/output and no `default` is set, the entire key/value line for that field is omitted from the rendered output.
      *
-     * **Object mode** (e.g. `"{name} ({age})"`): triggered when `{key}` and `{value}` are absent. Placeholders must be actual field keys defined in `fields`. Applied once for the whole object, composing all fields into a single string. Fields rendering to null become empty string.
+     * **Object mode** (e.g. `"{name} ({age})"`): triggered when `{key}` and `{value}` are absent. Placeholders must be actual field keys defined in `fields`. Applied once for the whole object, composing all fields into a single string. When a field has no relevant input/output and no `default` is set, its placeholder is replaced with an empty string (`""`).
      *
      * Validation rules: format must not be empty; if either `{key}` or `{value}` appears, both must be present; in subheading mode no extra placeholders are allowed; in object mode every placeholder must match a defined field key.
      */

package/dist/cjs/api/types/GuidedSection.d.ts

@@ -28,6 +28,4 @@ export interface GuidedSection {
     updatedAt: Date;
     /** Present when the section has been deleted. GET by ID still returns the full resource with this field populated. */
     deletedAt?: Date | null;
-    /** Access policies for this section. */
-    policies?: Corti.GuidedSectionPolicy[];
 }

package/dist/cjs/api/types/GuidedSectionsCreateBase.d.ts

@@ -14,6 +14,4 @@ export interface GuidedSectionsCreateBase {
     labels?: Corti.GuidedLabel[];
     /** Defaults to true when omitted. Set this to false if you do not want the section to automatically show up in LIST /sections. */
     publish?: boolean;
-    /** Access policies to apply to the section on creation. */
-    policies?: Corti.GuidedSectionsCreatePolicyRequest[];
 }

package/dist/cjs/api/types/GuidedStringNode.d.ts

@@ -1,11 +1,11 @@
 export interface GuidedStringNode {
     type: "string";
-    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
     description?: string;
-    /** The default to output if nothing to output. */
+    /** If nothing is outputted, this default is used. When `enum` is set, the default must be one of the enum values. */
     default?: string | null;
-    /** Can be used to prompt the LLM with specific values to output. */
+    /** Can be used to guide the LLM with specific values to output. */
     enum?: string[];
-    /** Can be used to prompt the LLM for a specific output pattern. */
+    /** Can be used to constrain the LLM to output a specific pattern. */
     pattern?: string | null;
 }

package/dist/cjs/api/types/GuidedTemplate.d.ts

@@ -20,8 +20,6 @@ export interface GuidedTemplate {
     specialties: string[];
     /** The available labels to use as query param filter in the LIST /templates endpoint. */
     labels: Corti.GuidedLabel[];
-    /** Access policies for this template. */
-    policies?: Corti.GuidedTemplatePolicy[];
     /** The currently published version with inheritance fully resolved. Present when a version has been published. */
     publishedVersion?: Corti.GuidedTemplateVersion;
     /** The original timestamp when the template was created. */

package/dist/cjs/api/types/GuidedTemplatesCreateBase.d.ts

@@ -14,6 +14,4 @@ export interface GuidedTemplatesCreateBase {
     labels?: Corti.GuidedLabel[];
     /** Defaults to true when omitted. Set this to false if you do not want the template to automatically show up in LIST templates. */
     publish?: boolean;
-    /** Access policies to apply to the template on creation. */
-    policies?: Corti.GuidedTemplatesCreatePolicyRequest[];
 }

package/dist/cjs/api/types/StreamConfig.d.ts

@@ -5,6 +5,10 @@ export interface StreamConfig {
     /** Optional parameter to specify data retention policy for the generated transcripts and facts. Use value 'none' to indicate data should not be stored in the database. Use value 'retain' to indicate that the data should be retained according to standard retention policies. If configuration is not provided, then the default retention policy will apply. */
     retentionPolicy?: Corti.StreamConfigRetentionPolicy;
     audioEvents?: Corti.StreamAudioEventsConfig;
-    /** The audio format of the incoming audio stream */
+    /** Define the audio format of the incoming audio stream - optional but recommended. When omitted, the server auto-detects the format from the first audio chunk using ffprobe. Supported audio will be processed. Unsupported return an error but might in some cases error silently. If provided (recommended), the provided MIME type must be supported and the audio must match the MIME type. An unsupported MIME type results in `CONFIG_REJECTED`. Audio that differs from the MIME type will return audio validation errors on the socket. See full list of supported MIME types [here](/stt/audio). */
     audioFormat?: string;
+    /** Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. */
+    replacements?: Corti.StreamConfigReplacementsItem[];
+    /** Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. Configuration is case sensitive and limited to 1,000 key terms per stream. */
+    keyterms?: Corti.StreamConfigKeyterms;
 }

package/dist/cjs/api/types/StreamConfigKeyterms.d.ts

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. Configuration is case sensitive and limited to 1,000 key terms per stream.
+ */
+export interface StreamConfigKeyterms {
+    /** Ordered list of words to be recognized. */
+    terms?: Corti.StreamConfigKeytermsTermsItem[];
+}

package/dist/cjs/api/types/StreamConfigKeytermsTermsItem.d.ts

@@ -0,0 +1,4 @@
+export interface StreamConfigKeytermsTermsItem {
+    /** The word to be recognized, defined in its expected written form. */
+    term: string;
+}

package/dist/cjs/api/types/StreamConfigReplacementsItem.d.ts

@@ -0,0 +1,6 @@
+export interface StreamConfigReplacementsItem {
+    /** The term to be replaced, such as "BID". */
+    find: string;
+    /** The preferred replacement for the term, such as "twice daily". */
+    replace: string;
+}

package/dist/cjs/api/types/StreamErrorDetail.d.ts

@@ -1,12 +1,14 @@
 export interface StreamErrorDetail {
+    /** Unique identifier for the request, for support and debugging. */
+    requestid?: string;
     /** Error identifier */
-    id: string;
+    id?: string;
     /** Error title */
-    title: string;
+    title?: string;
     /** HTTP status code or similar error code */
-    status: number;
+    status?: number;
     /** Detailed error message */
-    details: string;
+    details?: string;
     /** Link to documentation or further information */
-    doc: string;
+    doc?: string;
 }

package/dist/cjs/api/types/TranscribeAudioEventsConfig.d.ts

@@ -1,4 +1,4 @@
 export interface TranscribeAudioEventsConfig {
     /** When true, enables audio quality and speech activity events to be sent over the WebSocket. Disabled by default. */
-    enabled?: boolean;
+    enabled: boolean;
 }

package/dist/cjs/api/types/TranscribeCommand.d.ts

@@ -1,9 +1,9 @@
 import type * as Corti from "../index.js";
 export interface TranscribeCommand {
-    /** To identify the command when it gets detected and returned over the WebSocket */
+    /** Unique value to identify the command when it is detected and returned over the WebSocket */
     id: string;
-    /** The spoken phrases that should trigger the command */
+    /** One or more word sequence(s) that can be spoken to trigger the command. At least one phrase is required per command. */
     phrases: string[];
-    /** Variables for the command */
+    /** Placeholders that can (optionally) be added in phrases to provide flexibility and extensibility for triggering commands. */
     variables?: Corti.TranscribeCommandVariable[];
 }

package/dist/cjs/api/types/TranscribeCommandVariable.d.ts

@@ -1,8 +1,9 @@
+import type * as Corti from "../index.js";
 export interface TranscribeCommandVariable {
-    /** Variable key identifier */
+    /** Define the variable used in command phrases. */
     key: string;
-    /** Variable type */
-    type: "enum";
-    /** Enum values for the variable */
-    enum: string[];
+    /** Variable type. Use `enum` to define a fixed list of values that can be recognized for the variable. Use `wildcard` to recognize any undefined, open-ended free-text utterance. When using `wildcard`, the phrase must include a literal trigger word before the wildcard variable (a phrase may not begin with a wildcard variable), and multiple wildcard variables in a single phrase must be separated by a non-empty literal string (e.g. `select {text1} end select {text2}` is valid; `{text1} {text2}` is not). */
+    type: Corti.TranscribeCommandVariableType;
+    /** List of values that should be recognized for the defined variable. Required when `type` is `enum`. Not used (and ignored) when `type` is `wildcard`. */
+    enum?: string[];
 }

package/dist/cjs/api/types/TranscribeCommandVariableType.d.ts

@@ -0,0 +1,6 @@
+/** Variable type. Use `enum` to define a fixed list of values that can be recognized for the variable. Use `wildcard` to recognize any undefined, open-ended free-text utterance. When using `wildcard`, the phrase must include a literal trigger word before the wildcard variable (a phrase may not begin with a wildcard variable), and multiple wildcard variables in a single phrase must be separated by a non-empty literal string (e.g. `select {text1} end select {text2}` is valid; `{text1} {text2}` is not). */
+export declare const TranscribeCommandVariableType: {
+    readonly Enum: "enum";
+    readonly Wildcard: "wildcard";
+};
+export type TranscribeCommandVariableType = (typeof TranscribeCommandVariableType)[keyof typeof TranscribeCommandVariableType];

package/dist/cjs/api/types/TranscribeCommandVariableType.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranscribeCommandVariableType = void 0;
+/** Variable type. Use `enum` to define a fixed list of values that can be recognized for the variable. Use `wildcard` to recognize any undefined, open-ended free-text utterance. When using `wildcard`, the phrase must include a literal trigger word before the wildcard variable (a phrase may not begin with a wildcard variable), and multiple wildcard variables in a single phrase must be separated by a non-empty literal string (e.g. `select {text1} end select {text2}` is valid; `{text1} {text2}` is not). */
+exports.TranscribeCommandVariableType = {
+    Enum: "enum",
+    Wildcard: "wildcard",
+};

package/dist/cjs/api/types/TranscribeConfig.d.ts

@@ -2,16 +2,20 @@ import type * as Corti from "../index.js";
 export interface TranscribeConfig {
     /** The locale of the primary spoken language. */
     primaryLanguage: Corti.TranscribeSupportedLanguage;
-    /** When true, returns interim results for reduced latency */
+    /** When true, returns interim (preview) transcript results (`isFinal=false`) for reduced latency than final transcripts. Defaults to false. */
     interimResults?: boolean;
-    /** When true, converts spoken punctuation such as 'period' or 'slash' into '.' or '/' */
+    /** When true, converts spoken punctuation such as 'period' or 'slash' into '.' or '/'. Defaults to false. Overrides automaticPunctuation when both are enabled. */
     spokenPunctuation?: boolean;
-    /** When true, automatically punctuates and capitalizes in the final transcript */
+    /** When true, automatically punctuates and capitalizes in the final transcript. Defaults to false. Overridden by spokenPunctuation when both are enabled. */
     automaticPunctuation?: boolean;
     /** Commands that should be registered and detected */
     commands?: Corti.TranscribeCommand[];
     formatting?: Corti.TranscribeFormatting;
     audioEvents?: Corti.TranscribeAudioEventsConfig;
-    /** The audio format of the incoming audio stream */
+    /** Define the audio format of the incoming audio stream - optional but recommended. When omitted, the server auto-detects the format from the first audio chunk using ffprobe. Supported audio will be processed. Unsupported return an error but might in some cases error silently. If provided (recommended), the provided MIME type must be supported and the audio must match the MIME type. An unsupported MIME type results in `CONFIG_REJECTED`. Audio that differs from the MIME type will return audio validation errors on the socket. See full list of supported MIME types [here](/stt/audio). */
     audioFormat?: string;
+    /** Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. */
+    replacements?: Corti.TranscribeConfigReplacementsItem[];
+    /** Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. Configuration is case sensitive and limited to 1,000 key terms per stream. */
+    keyterms?: Corti.TranscribeConfigKeyterms;
 }

package/dist/cjs/api/types/TranscribeConfigKeyterms.d.ts

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. Configuration is case sensitive and limited to 1,000 key terms per stream.
+ */
+export interface TranscribeConfigKeyterms {
+    /** Ordered list of words to be recognized. */
+    terms?: Corti.TranscribeConfigKeytermsTermsItem[];
+}

package/dist/cjs/api/types/TranscribeConfigKeytermsTermsItem.d.ts

@@ -0,0 +1,4 @@
+export interface TranscribeConfigKeytermsTermsItem {
+    /** The word to be recognized, defined in its expected written form. */
+    term: string;
+}

package/dist/cjs/api/types/TranscribeConfigKeytermsTermsItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TranscribeConfigReplacementsItem.d.ts

@@ -0,0 +1,6 @@
+export interface TranscribeConfigReplacementsItem {
+    /** The term to be replaced, such as "BID". */
+    find: string;
+    /** The preferred replacement for the term, such as "twice daily". */
+    replace: string;
+}

package/dist/cjs/api/types/TranscribeConfigReplacementsItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TranscribeErrorMessageError.d.ts

@@ -1,12 +1,14 @@
 export interface TranscribeErrorMessageError {
+    /** Unique identifier for the request, for support and debugging. */
+    requestid?: string;
     /** Unique error identifier */
-    id: string;
+    id?: string;
     /** Error title */
-    title: string;
+    title?: string;
     /** HTTP status code */
-    status: number;
+    status?: number;
     /** Detailed error description */
-    details: string;
+    details?: string;
     /** Link to documentation */
-    doc: string;
+    doc?: string;
 }

package/dist/cjs/api/types/TranscribeSupportedLanguage.d.ts

@@ -1,4 +1,4 @@
 /**
- * Supported language codes for transcription
+ * Supported language codes for transcription. See details and available language codes [here](https://docs.corti.ai/stt/languages).
  */
 export type TranscribeSupportedLanguage = string;

package/dist/cjs/api/types/index.d.ts

@@ -143,12 +143,10 @@ export * from "./GuidedSectionInstructionsOverride.js";
 export * from "./GuidedSectionInstructionsPartial.js";
 export * from "./GuidedSectionOverride.js";
 export * from "./GuidedSectionOverrides.js";
-export * from "./GuidedSectionPolicy.js";
 export * from "./GuidedSectionSource.js";
 export * from "./GuidedSectionsCreateBase.js";
 export * from "./GuidedSectionsCreateFromInheritanceRequest.js";
 export * from "./GuidedSectionsCreateFromScratchRequest.js";
-export * from "./GuidedSectionsCreatePolicyRequest.js";
 export * from "./GuidedSectionsCreateRequest.js";
 export * from "./GuidedSectionVersion.js";
 export * from "./GuidedShallowTemplateGeneration.js";
@@ -160,8 +158,6 @@ export * from "./GuidedTemplateGeneration.js";
 export * from "./GuidedTemplateInstructions.js";
 export * from "./GuidedTemplateInstructionsPartial.js";
 export * from "./GuidedTemplateOverrides.js";
-export * from "./GuidedTemplatePolicy.js";
-export * from "./GuidedTemplatePolicyKind.js";
 export * from "./GuidedTemplateRef.js";
 export * from "./GuidedTemplateSource.js";
 export * from "./GuidedTemplatesCreateBase.js";
@@ -169,7 +165,6 @@ export * from "./GuidedTemplatesCreateFromInheritanceRequest.js";
 export * from "./GuidedTemplatesCreateFromInheritanceRequestGeneration.js";
 export * from "./GuidedTemplatesCreateFromScratchRequest.js";
 export * from "./GuidedTemplatesCreateFromScratchRequestGeneration.js";
-export * from "./GuidedTemplatesCreatePolicyRequest.js";
 export * from "./GuidedTemplatesCreateRequest.js";
 export * from "./GuidedTemplatesVersionGeneration.js";
 export * from "./GuidedTemplatesVersionSectionRequest.js";
@@ -195,12 +190,15 @@ export * from "./StreamAudioEventDataEvent.js";
 export * from "./StreamAudioEventMessage.js";
 export * from "./StreamAudioEventsConfig.js";
 export * from "./StreamConfig.js";
+export * from "./StreamConfigKeyterms.js";
+export * from "./StreamConfigKeytermsTermsItem.js";
 export * from "./StreamConfigMessage.js";
 export * from "./StreamConfigMode.js";
 export * from "./StreamConfigModeFactGenerationInterval.js";
 export * from "./StreamConfigModeType.js";
 export * from "./StreamConfigParticipant.js";
 export * from "./StreamConfigParticipantRole.js";
+export * from "./StreamConfigReplacementsItem.js";
 export * from "./StreamConfigRetentionPolicy.js";
 export * from "./StreamConfigStatusMessage.js";
 export * from "./StreamConfigStatusMessageType.js";
@@ -238,8 +236,12 @@ export * from "./TranscribeCommand.js";
 export * from "./TranscribeCommandData.js";
 export * from "./TranscribeCommandMessage.js";
 export * from "./TranscribeCommandVariable.js";
+export * from "./TranscribeCommandVariableType.js";
 export * from "./TranscribeConfig.js";
+export * from "./TranscribeConfigKeyterms.js";
+export * from "./TranscribeConfigKeytermsTermsItem.js";
 export * from "./TranscribeConfigMessage.js";
+export * from "./TranscribeConfigReplacementsItem.js";
 export * from "./TranscribeConfigStatusMessage.js";
 export * from "./TranscribeConfigStatusMessageType.js";
 export * from "./TranscribeDeltaUsageMessage.js";