retell-sdk 5.63.0 → 5.65.0

package/src/resources/agent.ts

@@ -148,17 +148,30 @@ export class Agent extends APIResource {
   }
 
   /**
-   * Get all versions of an agent
+   * Get agent versions. Large version histories may be truncated.
+   *
+   * @deprecated
+   */
+  getVersions(agentID: string, options?: RequestOptions): APIPromise<AgentGetVersionsResponse> {
+    return this._client.get(path`/get-agent-versions/${agentID}`, options);
+  }
+
+  /**
+   * List stored versions of a voice or chat agent with pagination.
    *
    * @example
    * ```ts
-   * const agentResponses = await client.agent.getVersions(
+   * const response = await client.agent.listVersions(
    *   '16b980523634a6dc504898cda492e939',
    * );
    * ```
    */
-  getVersions(agentID: string, options?: RequestOptions): APIPromise<AgentGetVersionsResponse> {
-    return this._client.get(path`/get-agent-versions/${agentID}`, options);
+  listVersions(
+    agentID: string,
+    query: AgentListVersionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentListVersionsResponse> {
+    return this._client.get(path`/list-agent-versions/${agentID}`, { query, ...options });
   }
 
   /**
@@ -176,6 +189,31 @@ export class Agent extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Remove references to resources that no longer exist in your workspace from an
+   * agent draft version and its response engine — tools whose app connection has
+   * been deleted, unknown knowledge bases, and deleted shared components — and remap
+   * voices that are no longer accessible to a default voice. If the agent's response
+   * engine version has been published, the engine is left untouched and only
+   * agent-level references are repaired. Repairing an agent with nothing to fix is a
+   * no-op.
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.repair(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
+   */
+  repair(
+    agentID: string,
+    params: AgentRepairParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentRepairResponse> {
+    const { version } = params ?? {};
+    return this._client.post(path`/repair-agent/${agentID}`, { query: { version }, ...options });
+  }
 }
 
 export interface AgentResponse {
@@ -741,6 +779,7 @@ export interface AgentResponse {
     | 'sonic-3'
     | 'sonic-3-latest'
     | 'sonic-3.5'
+    | 'sonic-3.6'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
     | 'speech-02-turbo'
@@ -748,6 +787,8 @@ export interface AgentResponse {
     | 's1'
     | 's2-pro'
     | 's2.1-pro'
+    | 'inworld-tts-2'
+    | 'inworld-tts-2-flash'
     | null;
 
   /**
@@ -882,7 +923,9 @@ export namespace AgentResponse {
   export interface CustomSttConfig {
     /**
      * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-     * 500 for Soniox, 100 for AssemblyAI.
+     * 500 for Soniox, 100 for AssemblyAI. For AssemblyAI, this sets min_turn_silence
+     * (100-3000 ms). max_turn_silence adds half of this value, rounded to the nearest
+     * millisecond and bounded to 500-1000 ms, with a total cap of 3000 ms.
      */
     endpointing_ms: number;
 
@@ -1290,9 +1333,9 @@ export interface AgentListResponse {
   /**
    * Whether more results are available.
    */
-  has_more?: boolean;
+  has_more: boolean;
 
-  items?: Array<AgentListResponse.Item>;
+  items: Array<AgentListResponse.Item>;
 
   /**
    * Pagination key for the next page.
@@ -1339,6 +1382,56 @@ export type AgentCreateVersionResponse = AgentResponse | ChatAgentAPI.ChatAgentR
 
 export type AgentGetVersionsResponse = Array<AgentResponse>;
 
+export interface AgentListVersionsResponse {
+  /**
+   * Whether more results are available.
+   */
+  has_more: boolean;
+
+  items: Array<AgentListVersionsResponse.Item>;
+
+  /**
+   * Pagination key for the next page.
+   */
+  pagination_key?: string;
+}
+
+export namespace AgentListVersionsResponse {
+  export interface Item {
+    /**
+     * Whether the agent version is published.
+     */
+    is_published: boolean;
+
+    /**
+     * Last modification timestamp in milliseconds since epoch.
+     */
+    last_modification_timestamp: number;
+
+    /**
+     * Version number of the agent.
+     */
+    version: number;
+
+    /**
+     * Version that this agent version was based on.
+     */
+    base_version?: number;
+
+    /**
+     * Optional description of the agent version.
+     */
+    version_description?: string;
+
+    /**
+     * Optional title of the agent version.
+     */
+    version_title?: string;
+  }
+}
+
+export type AgentRepairResponse = AgentResponse | ChatAgentAPI.ChatAgentResponse;
+
 export interface AgentCreateParams {
   /**
    * The Response Engine to attach to the agent. It is used to generate responses for
@@ -1871,6 +1964,7 @@ export interface AgentCreateParams {
     | 'sonic-3'
     | 'sonic-3-latest'
     | 'sonic-3.5'
+    | 'sonic-3.6'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
     | 'speech-02-turbo'
@@ -1878,6 +1972,8 @@ export interface AgentCreateParams {
     | 's1'
     | 's2-pro'
     | 's2.1-pro'
+    | 'inworld-tts-2'
+    | 'inworld-tts-2-flash'
     | null;
 
   /**
@@ -2012,7 +2108,9 @@ export namespace AgentCreateParams {
   export interface CustomSttConfig {
     /**
      * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-     * 500 for Soniox, 100 for AssemblyAI.
+     * 500 for Soniox, 100 for AssemblyAI. For AssemblyAI, this sets min_turn_silence
+     * (100-3000 ms). max_turn_silence adds half of this value, rounded to the nearest
+     * millisecond and bounded to 500-1000 ms, with a total cap of 3000 ms.
      */
     endpointing_ms: number;
 
@@ -2973,6 +3071,7 @@ export interface AgentUpdateParams {
     | 'sonic-3'
     | 'sonic-3-latest'
     | 'sonic-3.5'
+    | 'sonic-3.6'
     | 'tts-1'
     | 'gpt-4o-mini-tts'
     | 'speech-02-turbo'
@@ -2980,6 +3079,8 @@ export interface AgentUpdateParams {
     | 's1'
     | 's2-pro'
     | 's2.1-pro'
+    | 'inworld-tts-2'
+    | 'inworld-tts-2-flash'
     | null;
 
   /**
@@ -3068,7 +3169,9 @@ export namespace AgentUpdateParams {
   export interface CustomSttConfig {
     /**
      * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
-     * 500 for Soniox, 100 for AssemblyAI.
+     * 500 for Soniox, 100 for AssemblyAI. For AssemblyAI, this sets min_turn_silence
+     * (100-3000 ms). max_turn_silence adds half of this value, rounded to the nearest
+     * millisecond and bounded to 500-1000 ms, with a total cap of 3000 ms.
      */
     endpointing_ms: number;
 
@@ -3583,6 +3686,23 @@ export interface AgentDeleteVersionParams {
   version: number;
 }
 
+export interface AgentListVersionsParams {
+  /**
+   * Maximum number of items to return.
+   */
+  limit?: number;
+
+  /**
+   * Pagination key for fetching the next page.
+   */
+  pagination_key?: string;
+
+  /**
+   * Sort order for results.
+   */
+  sort_order?: 'ascending' | 'descending';
+}
+
 export interface AgentPublishParams {
   version: number;
 
@@ -3594,18 +3714,30 @@ export interface AgentPublishParams {
   version_title?: string;
 }
 
+export interface AgentRepairParams {
+  /**
+   * Optional version of the agent to repair. Default to latest version. Published
+   * versions are immutable and cannot be repaired.
+   */
+  version?: string | number;
+}
+
 export declare namespace Agent {
   export {
     type AgentResponse as AgentResponse,
     type AgentListResponse as AgentListResponse,
     type AgentCreateVersionResponse as AgentCreateVersionResponse,
     type AgentGetVersionsResponse as AgentGetVersionsResponse,
+    type AgentListVersionsResponse as AgentListVersionsResponse,
+    type AgentRepairResponse as AgentRepairResponse,
     type AgentCreateParams as AgentCreateParams,
     type AgentRetrieveParams as AgentRetrieveParams,
     type AgentUpdateParams as AgentUpdateParams,
     type AgentListParams as AgentListParams,
     type AgentCreateVersionParams as AgentCreateVersionParams,
     type AgentDeleteVersionParams as AgentDeleteVersionParams,
+    type AgentListVersionsParams as AgentListVersionsParams,
     type AgentPublishParams as AgentPublishParams,
+    type AgentRepairParams as AgentRepairParams,
   };
 }