phonic 0.11.0 → 0.13.0

package/README.md

@@ -7,6 +7,9 @@ Node.js library for the Phonic API.
 - [Usage](#usage)
   - [Get voices](#get-voices)
   - [Get voice by id](#get-voice-by-id)
+  - [Get conversation by id](#get-conversation-by-id)
+  - [Get conversation by external id](#get-conversation-by-external-id)
+  - [List conversations](#list-conversations)
   - [Speech-to-speech via WebSocket](#speech-to-speech-via-websocket)
 
 ## Installation
@@ -38,7 +41,7 @@ if (error === null) {
 ```
 
 
-### Get voice by ID
+### Get voice by id
 
 ```ts
 const { data, error } = await phonic.voices.get("meredith");
@@ -48,6 +51,41 @@ if (error === null) {
 }
 ```
 
+### Get conversation by id
+
+```ts
+const { data, error } = await phonic.conversations.get("conv_b1804883-5be4-42fe-b1cf-aa84450d5c84");
+
+if (error === null) {
+  console.log(data.conversation);
+}
+```
+
+### Get conversation by external id
+
+```ts
+const { data, error } = await phonic.conversations.getByExternalId("CAdb9c032c809fec7feb932ea4c96d71e1");
+
+if (error === null) {
+  console.log(data.conversation);
+}
+```
+
+### List conversations
+
+```ts
+const { data, error } = await phonic.conversations.list({
+  durationMin: 10000, // ms
+  durationMax: 20000, // ms
+  startedAtMin: "2025-04-17", // 00:00:00 UTC time is assumed
+  startedAtMax: "2025-09-05T10:30:00.000Z",
+});
+
+if (error === null) {
+  console.log(data.conversations);
+}
+```
+
 ### Speech-to-speech via WebSocket
 
 To start a conversation, open a WebSocket connection:
@@ -113,7 +151,7 @@ phonicWebSocket.updateSystemPrompt({
 })
 ```
 
-Set an external ID for the conversation (can be the Twilio Call SID, for example):
+Set an external id for the conversation (can be the Twilio Call SID, for example):
 
 ```ts
 phonicWebSocket.setExternalId({

package/dist/index.d.mts

@@ -19,6 +19,58 @@ type DataOrError<T> = Promise<{
     data: null;
     error: ErrorResponse;
 }>;
+type ISODate = `${string}-${string}-${string}`;
+type ISODateTime$1 = `${string}Z`;
+
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+type ConversationsSuccessResponse = {
+    conversations: Array<Conversation>;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
+    list({ durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+}
 
 type PhonicSTSConfig = {
     input_format: "pcm_44100" | "mulaw_8000";
@@ -112,6 +164,7 @@ declare class Phonic {
     readonly baseUrl: string;
     readonly __downstreamWebSocketUrl: string | null;
     readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.d.ts

@@ -19,6 +19,58 @@ type DataOrError<T> = Promise<{
     data: null;
     error: ErrorResponse;
 }>;
+type ISODate = `${string}-${string}-${string}`;
+type ISODateTime$1 = `${string}Z`;
+
+type ISODateTime = `${string}Z`;
+type ConversationItem = {
+    role: "user";
+    item_idx: number;
+    text: string;
+    duration_ms: number;
+    started_at: string;
+} | {
+    role: "assistant";
+    item_idx: number;
+    text: string;
+    voice_id: string;
+    system_prompt: string;
+    output_audio_speed: number;
+    duration_ms: number;
+    started_at: string;
+};
+type Conversation = {
+    id: string;
+    external_id: string | null;
+    model: string;
+    welcome_message: string | null;
+    input_format: "pcm_44100" | "mulaw_8000";
+    output_format: "pcm_44100" | "mulaw_8000";
+    text: string;
+    duration_ms: number;
+    started_at: ISODateTime;
+    ended_at: ISODateTime;
+    items: Array<ConversationItem>;
+};
+type ConversationSuccessResponse = {
+    conversation: Conversation;
+};
+type ConversationsSuccessResponse = {
+    conversations: Array<Conversation>;
+};
+
+declare class Conversations {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    get(id: string): DataOrError<ConversationSuccessResponse>;
+    getByExternalId(externalId: string): DataOrError<ConversationSuccessResponse>;
+    list({ durationMin, durationMax, startedAtMin, startedAtMax, }: {
+        durationMin?: number;
+        durationMax?: number;
+        startedAtMin?: ISODate | ISODateTime$1;
+        startedAtMax?: ISODate | ISODateTime$1;
+    }): DataOrError<ConversationsSuccessResponse>;
+}
 
 type PhonicSTSConfig = {
     input_format: "pcm_44100" | "mulaw_8000";
@@ -112,6 +164,7 @@ declare class Phonic {
     readonly baseUrl: string;
     readonly __downstreamWebSocketUrl: string | null;
     readonly headers: Record<string, string>;
+    readonly conversations: Conversations;
     readonly voices: Voices;
     readonly sts: SpeechToSpeech;
     constructor(apiKey: string, config?: PhonicConfig);

package/dist/index.js

@@ -35,7 +35,46 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // package.json
-var version = "0.11.0";
+var version = "0.13.0";
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
+  }
+  async getByExternalId(externalId) {
+    const queryString = new URLSearchParams({
+      external_id: externalId
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+  async list({
+    durationMin,
+    durationMax,
+    startedAtMin,
+    startedAtMax
+  }) {
+    const queryString = new URLSearchParams({
+      ...durationMin !== void 0 && { duration_min: String(durationMin) },
+      ...durationMax !== void 0 && { duration_max: String(durationMax) },
+      ...startedAtMin !== void 0 && { started_at_min: startedAtMin },
+      ...startedAtMax !== void 0 && { started_at_max: startedAtMax }
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+};
 
 // src/sts/index.ts
 var import_ws = __toESM(require("ws"));
@@ -256,6 +295,7 @@ var Phonic = class {
   baseUrl;
   __downstreamWebSocketUrl;
   headers;
+  conversations = new Conversations(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/dist/index.mjs

@@ -1,5 +1,44 @@
 // package.json
-var version = "0.11.0";
+var version = "0.13.0";
+
+// src/conversations/index.ts
+var Conversations = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/conversations/${id}`
+    );
+    return response;
+  }
+  async getByExternalId(externalId) {
+    const queryString = new URLSearchParams({
+      external_id: externalId
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+  async list({
+    durationMin,
+    durationMax,
+    startedAtMin,
+    startedAtMax
+  }) {
+    const queryString = new URLSearchParams({
+      ...durationMin !== void 0 && { duration_min: String(durationMin) },
+      ...durationMax !== void 0 && { duration_max: String(durationMax) },
+      ...startedAtMin !== void 0 && { started_at_min: startedAtMin },
+      ...startedAtMax !== void 0 && { started_at_max: startedAtMax }
+    }).toString();
+    const response = await this.phonic.get(
+      `/conversations?${queryString}`
+    );
+    return response;
+  }
+};
 
 // src/sts/index.ts
 import WebSocket from "ws";
@@ -220,6 +259,7 @@ var Phonic = class {
   baseUrl;
   __downstreamWebSocketUrl;
   headers;
+  conversations = new Conversations(this);
   voices = new Voices(this);
   sts = new SpeechToSpeech(this);
   async fetchRequest(path, options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "phonic",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Phonic Node.js SDK",
   "scripts": {
     "build": "tsup",