chatbase 0.3.0 → 0.4.0

package/README.md

@@ -77,6 +77,7 @@ calls you invoke.
 * [`chatbase tickets reply [TICKETNUMBER]`](#chatbase-tickets-reply-ticketnumber)
 * [`chatbase tickets search QUERY`](#chatbase-tickets-search-query)
 * [`chatbase tickets update TICKETNUMBER`](#chatbase-tickets-update-ticketnumber)
+* [`chatbase voice start`](#chatbase-voice-start)
 * [`chatbase whatsapp send-template TEMPLATE`](#chatbase-whatsapp-send-template-template)
 * [`chatbase whatsapp templates`](#chatbase-whatsapp-templates)
 
@@ -115,7 +116,7 @@ EXAMPLES
   $ chatbase agents auto-retrain --enabled
 ```
 
-_See code: [src/commands/agents/auto-retrain.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/auto-retrain.ts)_
+_See code: [src/commands/agents/auto-retrain.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/auto-retrain.ts)_
 
 ## `chatbase agents clone AGENTID`
 
@@ -145,7 +146,7 @@ EXAMPLES
   $ chatbase agents clone agt_123
 ```
 
-_See code: [src/commands/agents/clone.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/clone.ts)_
+_See code: [src/commands/agents/clone.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/clone.ts)_
 
 ## `chatbase agents create`
 
@@ -180,7 +181,7 @@ EXAMPLES
   $ chatbase agents create --data @agent.json
 ```
 
-_See code: [src/commands/agents/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/create.ts)_
+_See code: [src/commands/agents/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/create.ts)_
 
 ## `chatbase agents delete AGENTID`
 
@@ -211,7 +212,7 @@ EXAMPLES
   $ chatbase agents delete agt_123 --confirm agt_123
 ```
 
-_See code: [src/commands/agents/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/delete.ts)_
+_See code: [src/commands/agents/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/delete.ts)_
 
 ## `chatbase agents get [AGENTID]`
 
@@ -246,7 +247,7 @@ EXAMPLES
   $ chatbase agents get
 ```
 
-_See code: [src/commands/agents/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/get.ts)_
+_See code: [src/commands/agents/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/get.ts)_
 
 ## `chatbase agents list`
 
@@ -279,7 +280,7 @@ EXAMPLES
   $ chatbase agents list --json
 ```
 
-_See code: [src/commands/agents/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/list.ts)_
+_See code: [src/commands/agents/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/list.ts)_
 
 ## `chatbase agents styles [AGENTID]`
 
@@ -316,7 +317,7 @@ EXAMPLES
   $ chatbase agents styles --data @styles.json
 ```
 
-_See code: [src/commands/agents/styles.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/styles.ts)_
+_See code: [src/commands/agents/styles.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/styles.ts)_
 
 ## `chatbase agents train [AGENTID]`
 
@@ -351,7 +352,7 @@ EXAMPLES
   $ chatbase agents train
 ```
 
-_See code: [src/commands/agents/train.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/train.ts)_
+_See code: [src/commands/agents/train.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/train.ts)_
 
 ## `chatbase agents update [AGENTID]`
 
@@ -393,7 +394,7 @@ EXAMPLES
   $ chatbase agents update agt_123 --data @agent.json
 ```
 
-_See code: [src/commands/agents/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/agents/update.ts)_
+_See code: [src/commands/agents/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/agents/update.ts)_
 
 ## `chatbase api METHOD PATH`
 
@@ -434,7 +435,7 @@ EXAMPLES
   $ chatbase api PATCH /agents/agt_123 --body @patch.json
 ```
 
-_See code: [src/commands/api.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/api.ts)_
+_See code: [src/commands/api.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/api.ts)_
 
 ## `chatbase auth login`
 
@@ -467,7 +468,7 @@ EXAMPLES
   cat key.txt | chatbase auth login --with-token
 ```
 
-_See code: [src/commands/auth/login.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/auth/login.ts)_
+_See code: [src/commands/auth/login.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/auth/login.ts)_
 
 ## `chatbase auth logout`
 
@@ -494,7 +495,7 @@ EXAMPLES
   $ chatbase auth logout
 ```
 
-_See code: [src/commands/auth/logout.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/auth/logout.ts)_
+_See code: [src/commands/auth/logout.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/auth/logout.ts)_
 
 ## `chatbase auth status`
 
@@ -521,7 +522,7 @@ EXAMPLES
   $ chatbase auth status
 ```
 
-_See code: [src/commands/auth/status.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/auth/status.ts)_
+_See code: [src/commands/auth/status.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/auth/status.ts)_
 
 ## `chatbase chat`
 
@@ -563,7 +564,7 @@ EXAMPLES
   $ chatbase chat -a agt_123 -m "hi" --json
 ```
 
-_See code: [src/commands/chat/index.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/chat/index.ts)_
+_See code: [src/commands/chat/index.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/chat/index.ts)_
 
 ## `chatbase chat retry`
 
@@ -598,7 +599,7 @@ EXAMPLES
   $ chatbase chat retry --conversation c_123 -a agt_123 --message-id msg_456 --no-stream
 ```
 
-_See code: [src/commands/chat/retry.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/chat/retry.ts)_
+_See code: [src/commands/chat/retry.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/chat/retry.ts)_
 
 ## `chatbase config get KEY`
 
@@ -630,7 +631,7 @@ EXAMPLES
   $ chatbase config get timeout
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/config/get.ts)_
+_See code: [src/commands/config/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/config/get.ts)_
 
 ## `chatbase config list`
 
@@ -657,7 +658,7 @@ EXAMPLES
   $ chatbase config list
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/config/list.ts)_
+_See code: [src/commands/config/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/config/list.ts)_
 
 ## `chatbase config set KEY [VALUE]`
 
@@ -692,7 +693,7 @@ EXAMPLES
   $ chatbase config set timeout 60000
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/config/set.ts)_
 
 ## `chatbase conversations export`
 
@@ -751,7 +752,7 @@ EXAMPLES
   $ chatbase conversations export -a agt_123 --conversation conv_123
 ```
 
-_See code: [src/commands/conversations/export.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/conversations/export.ts)_
+_See code: [src/commands/conversations/export.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/conversations/export.ts)_
 
 ## `chatbase conversations get [CONVERSATIONID]`
 
@@ -787,7 +788,7 @@ EXAMPLES
   $ chatbase conversations get --conversation conv_123 -a agt_123
 ```
 
-_See code: [src/commands/conversations/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/conversations/get.ts)_
+_See code: [src/commands/conversations/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/conversations/get.ts)_
 
 ## `chatbase conversations list`
 
@@ -838,7 +839,7 @@ EXAMPLES
   $ chatbase conversations list -a agt_123 --all --json
 ```
 
-_See code: [src/commands/conversations/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/conversations/list.ts)_
+_See code: [src/commands/conversations/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/conversations/list.ts)_
 
 ## `chatbase conversations tool-result [CONVERSATIONID]`
 
@@ -882,7 +883,7 @@ EXAMPLES
   $ chatbase conversations tool-result conv_123 --tool-call-id tc_1 -a agt_123
 ```
 
-_See code: [src/commands/conversations/tool-result.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/conversations/tool-result.ts)_
+_See code: [src/commands/conversations/tool-result.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/conversations/tool-result.ts)_
 
 ## `chatbase health`
 
@@ -911,7 +912,7 @@ EXAMPLES
   $ chatbase health --json
 ```
 
-_See code: [src/commands/health.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/health.ts)_
+_See code: [src/commands/health.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/health.ts)_
 
 ## `chatbase help [COMMAND]`
 
@@ -961,7 +962,7 @@ EXAMPLES
   $ chatbase helpdesk statuses -a agt_123
 ```
 
-_See code: [src/commands/helpdesk/statuses.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/helpdesk/statuses.ts)_
+_See code: [src/commands/helpdesk/statuses.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/helpdesk/statuses.ts)_
 
 ## `chatbase helpdesk teams`
 
@@ -991,7 +992,7 @@ EXAMPLES
   $ chatbase helpdesk teams -a agt_123
 ```
 
-_See code: [src/commands/helpdesk/teams.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/helpdesk/teams.ts)_
+_See code: [src/commands/helpdesk/teams.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/helpdesk/teams.ts)_
 
 ## `chatbase messages feedback [MESSAGEID]`
 
@@ -1030,7 +1031,7 @@ EXAMPLES
   $ chatbase messages feedback --conversation conv_123 --message msg_1 --rating clear -a agt_123
 ```
 
-_See code: [src/commands/messages/feedback.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/messages/feedback.ts)_
+_See code: [src/commands/messages/feedback.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/messages/feedback.ts)_
 
 ## `chatbase messages list`
 
@@ -1066,7 +1067,7 @@ EXAMPLES
   $ chatbase messages list --conversation conv_123 -a agt_123 --all --json
 ```
 
-_See code: [src/commands/messages/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/messages/list.ts)_
+_See code: [src/commands/messages/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/messages/list.ts)_
 
 ## `chatbase sources create`
 
@@ -1113,7 +1114,7 @@ EXAMPLES
   $ chatbase sources create --file ./guide.pdf -a agt_123
 ```
 
-_See code: [src/commands/sources/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/create.ts)_
+_See code: [src/commands/sources/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/create.ts)_
 
 ## `chatbase sources delete SOURCEID`
 
@@ -1146,7 +1147,7 @@ EXAMPLES
   $ chatbase sources delete src_1 -a agt_1
 ```
 
-_See code: [src/commands/sources/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/delete.ts)_
+_See code: [src/commands/sources/delete.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/delete.ts)_
 
 ## `chatbase sources get SOURCEID`
 
@@ -1179,7 +1180,7 @@ EXAMPLES
   $ chatbase sources get src_123 -a agt_123
 ```
 
-_See code: [src/commands/sources/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/get.ts)_
+_See code: [src/commands/sources/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/get.ts)_
 
 ## `chatbase sources list`
 
@@ -1216,7 +1217,7 @@ EXAMPLES
   $ chatbase sources list -a agt_123 --all --json
 ```
 
-_See code: [src/commands/sources/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/list.ts)_
+_See code: [src/commands/sources/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/list.ts)_
 
 ## `chatbase sources restore SOURCEID`
 
@@ -1249,7 +1250,7 @@ EXAMPLES
   $ chatbase sources restore src_1 -a agt_1
 ```
 
-_See code: [src/commands/sources/restore.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/restore.ts)_
+_See code: [src/commands/sources/restore.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/restore.ts)_
 
 ## `chatbase sources summary`
 
@@ -1279,7 +1280,7 @@ EXAMPLES
   $ chatbase sources summary -a agt_123
 ```
 
-_See code: [src/commands/sources/summary.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/summary.ts)_
+_See code: [src/commands/sources/summary.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/summary.ts)_
 
 ## `chatbase sources update SOURCEID`
 
@@ -1317,7 +1318,7 @@ EXAMPLES
   $ chatbase sources update src_1 --file ./updated.pdf -a agt_1
 ```
 
-_See code: [src/commands/sources/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/sources/update.ts)_
+_See code: [src/commands/sources/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/sources/update.ts)_
 
 ## `chatbase tickets create`
 
@@ -1355,7 +1356,7 @@ EXAMPLES
   $ chatbase tickets create --subject "Export failing" --data '{"description":"Customer cannot export.","customer":{"email":"jane@example.com"}}' -a agt_123
 ```
 
-_See code: [src/commands/tickets/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/create.ts)_
+_See code: [src/commands/tickets/create.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/create.ts)_
 
 ## `chatbase tickets get TICKETNUMBER`
 
@@ -1388,7 +1389,7 @@ EXAMPLES
   $ chatbase tickets get 42 -a agt_123
 ```
 
-_See code: [src/commands/tickets/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/get.ts)_
+_See code: [src/commands/tickets/get.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/get.ts)_
 
 ## `chatbase tickets list`
 
@@ -1438,7 +1439,7 @@ EXAMPLES
   $ chatbase tickets list -a agt_123 --all --json
 ```
 
-_See code: [src/commands/tickets/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/list.ts)_
+_See code: [src/commands/tickets/list.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/list.ts)_
 
 ## `chatbase tickets messages [TICKETNUMBER]`
 
@@ -1481,7 +1482,7 @@ EXAMPLES
   $ chatbase tickets messages 42 -a agt_123 --all --json
 ```
 
-_See code: [src/commands/tickets/messages.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/messages.ts)_
+_See code: [src/commands/tickets/messages.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/messages.ts)_
 
 ## `chatbase tickets reply [TICKETNUMBER]`
 
@@ -1520,7 +1521,7 @@ EXAMPLES
   $ chatbase tickets reply 42 -m "On it" --author-email sam@example.com -a agt_123
 ```
 
-_See code: [src/commands/tickets/reply.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/reply.ts)_
+_See code: [src/commands/tickets/reply.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/reply.ts)_
 
 ## `chatbase tickets search QUERY`
 
@@ -1556,7 +1557,7 @@ EXAMPLES
   $ chatbase tickets search "refund" -a agt_123 --limit 10 --json
 ```
 
-_See code: [src/commands/tickets/search.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/search.ts)_
+_See code: [src/commands/tickets/search.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/search.ts)_
 
 ## `chatbase tickets update TICKETNUMBER`
 
@@ -1592,7 +1593,51 @@ EXAMPLES
   $ chatbase tickets update 42 --data '{"statusCategory":"closed"}' -a agt_123
 ```
 
-_See code: [src/commands/tickets/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/tickets/update.ts)_
+_See code: [src/commands/tickets/update.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/tickets/update.ts)_
+
+## `chatbase voice start`
+
+Start a voice session
+
+```
+USAGE
+  $ chatbase voice start [--json] [--plain] [-q] [--verbose] [--no-input] [--no-color] [--agent-name <value> | -a
+    <value>] [--conversation <value>] [--user <value>] [--timezone <value>]
+
+FLAGS
+  -a, --agent=<value>         Agent ID (or set CHATBASE_AGENT_ID)
+  -q, --quiet                 Suppress non-essential output
+      --agent-name=<value>    Agent display name (looked up to an ID)
+      --conversation=<value>  Conversation ID to reuse, grouping several sessions into one conversation (default: start
+                              a new conversation)
+      --no-color              Disable colored output
+      --no-input              Never prompt; fail instead
+      --timezone=<value>      [default: UTC] IANA timezone of the end user, used by the agent for time-aware answers
+      --user=<value>          Your end-user ID; send a stable value so per-user voice limits apply (default: generated
+                              per session)
+      --verbose               Verbose diagnostics
+
+OUTPUT FLAGS
+  --json   Output raw API JSON
+  --plain  Tab-separated output for scripts
+
+DESCRIPTION
+  Start a voice session
+
+  Create a real-time voice session for an agent and print its credentials. Pass the response to the Chatbase Voice SDK
+  (@chatbase-co/voice-sdk) in your client: the SDK connects, publishes the microphone, and the agent joins
+  automatically. Requires a plan with voice mode enabled; voice minutes consume message credits. The participant token
+  is abbreviated in the default output — use --json or --plain for the full value.
+
+EXAMPLES
+  $ chatbase voice start -a agt_123
+
+  $ chatbase voice start --user user_42 --timezone Europe/Paris -a agt_123
+
+  $ chatbase voice start --conversation 0b6a1f2e-7c3d-4a5b-8e9f-1a2b3c4d5e6f --json -a agt_123
+```
+
+_See code: [src/commands/voice/start.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/voice/start.ts)_
 
 ## `chatbase whatsapp send-template TEMPLATE`
 
@@ -1636,7 +1681,7 @@ EXAMPLES
   $ chatbase whatsapp send-template order_update --to 14155552671 --language en_US --variables '{"header":{"1":"#1042"},"body":{"1":"Jane","2":"Friday"}}' -a agt_123
 ```
 
-_See code: [src/commands/whatsapp/send-template.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/whatsapp/send-template.ts)_
+_See code: [src/commands/whatsapp/send-template.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/whatsapp/send-template.ts)_
 
 ## `chatbase whatsapp templates`
 
@@ -1672,5 +1717,5 @@ EXAMPLES
   $ chatbase whatsapp templates -a agt_123 --json
 ```
 
-_See code: [src/commands/whatsapp/templates.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.3.0/src/commands/whatsapp/templates.ts)_
+_See code: [src/commands/whatsapp/templates.ts](https://github.com/Chatbase-co/chatbase-cli/blob/v0.4.0/src/commands/whatsapp/templates.ts)_
 <!-- commandsstop -->

package/dist/commands/voice/start.js

@@ -0,0 +1,78 @@
+import { Flags } from '@oclif/core';
+import { AgentCommand } from '../../base/agent-command.js';
+import { throwIfError } from '../../client/client.js';
+const VOICE_SESSION_COLUMNS = [
+    { key: 'sessionId', header: 'SESSION' },
+    { key: 'conversationId', header: 'CONVERSATION' },
+    { key: 'userId', header: 'USER' },
+    { key: 'roomName', header: 'ROOM' },
+    { key: 'maxDurationSeconds', header: 'MAX_SECONDS' },
+    { key: 'participantToken', header: 'TOKEN' }
+];
+export default class VoiceStart extends AgentCommand {
+    static summary = 'Start a voice session';
+    static description = 'Create a real-time voice session for an agent and print its ' +
+        'credentials. Pass the response to the Chatbase Voice SDK ' +
+        '(@chatbase-co/voice-sdk) in your client: the SDK connects, publishes ' +
+        'the microphone, and the agent joins automatically. Requires a plan ' +
+        'with voice mode enabled; voice minutes consume message credits. The ' +
+        'participant token is abbreviated in the default output — use --json ' +
+        'or --plain for the full value.';
+    static examples = [
+        '<%= config.bin %> voice start -a agt_123',
+        '<%= config.bin %> voice start --user user_42 --timezone Europe/Paris -a agt_123',
+        '<%= config.bin %> voice start --conversation 0b6a1f2e-7c3d-4a5b-8e9f-1a2b3c4d5e6f --json -a agt_123'
+    ];
+    static flags = {
+        ...AgentCommand.baseFlags,
+        conversation: Flags.string({
+            description: 'Conversation ID to reuse, grouping several sessions into one conversation (default: start a new conversation)'
+        }),
+        user: Flags.string({
+            description: 'Your end-user ID; send a stable value so per-user voice limits apply (default: generated per session)'
+        }),
+        timezone: Flags.string({
+            description: 'IANA timezone of the end user, used by the agent for time-aware answers',
+            default: 'UTC'
+        })
+    };
+    async run() {
+        const { flags } = await this.parse(VoiceStart);
+        const client = this.apiClient(flags);
+        const agentId = await this.agentId(flags, client);
+        // `timezone` carries a spec default, so it is required in the body type.
+        const body = {
+            timezone: flags.timezone,
+            ...(flags.conversation
+                ? { conversationId: flags.conversation }
+                : {}),
+            ...(flags.user ? { userId: flags.user } : {})
+        };
+        const { data, error, response } = await client.POST('/agents/{agentId}/voice/sessions', { params: { path: { agentId } }, body });
+        throwIfError(response, error);
+        const session = data.data;
+        const row = {
+            sessionId: session.sessionId,
+            conversationId: session.conversationId,
+            userId: session.userId,
+            roomName: session.roomName,
+            maxDurationSeconds: String(session.maxDurationSeconds),
+            participantToken: session.participantToken
+        };
+        this.success(flags, 'Voice session started');
+        this.printDetail(flags, data, row, VOICE_SESSION_COLUMNS, [
+            ['Session', session.sessionId],
+            ['Conversation', session.conversationId],
+            ['User', session.userId],
+            ['Room', session.roomName],
+            ['Max duration', `${session.maxDurationSeconds}s`],
+            [
+                'Token',
+                `${session.participantToken.slice(0, 16)}… (${session.participantToken.length} chars)`
+            ]
+        ]);
+        if (this.mode(flags) === 'pretty') {
+            this.note(flags, '→ rerun with --json to get the full participant token for the Voice SDK');
+        }
+    }
+}

package/oclif.manifest.json

@@ -4113,6 +4113,113 @@
         "update.js"
       ]
     },
+    "voice:start": {
+      "aliases": [],
+      "args": {},
+      "description": "Create a real-time voice session for an agent and print its credentials. Pass the response to the Chatbase Voice SDK (@chatbase-co/voice-sdk) in your client: the SDK connects, publishes the microphone, and the agent joins automatically. Requires a plan with voice mode enabled; voice minutes consume message credits. The participant token is abbreviated in the default output — use --json or --plain for the full value.",
+      "examples": [
+        "<%= config.bin %> voice start -a agt_123",
+        "<%= config.bin %> voice start --user user_42 --timezone Europe/Paris -a agt_123",
+        "<%= config.bin %> voice start --conversation 0b6a1f2e-7c3d-4a5b-8e9f-1a2b3c4d5e6f --json -a agt_123"
+      ],
+      "flags": {
+        "json": {
+          "description": "Output raw API JSON",
+          "helpGroup": "OUTPUT",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "plain": {
+          "description": "Tab-separated output for scripts",
+          "helpGroup": "OUTPUT",
+          "name": "plain",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress non-essential output",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "description": "Verbose diagnostics",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-input": {
+          "description": "Never prompt; fail instead",
+          "name": "no-input",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-color": {
+          "description": "Disable colored output",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "agent": {
+          "char": "a",
+          "description": "Agent ID (or set CHATBASE_AGENT_ID)",
+          "name": "agent",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "agent-name": {
+          "description": "Agent display name (looked up to an ID)",
+          "exclusive": [
+            "agent"
+          ],
+          "name": "agent-name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "conversation": {
+          "description": "Conversation ID to reuse, grouping several sessions into one conversation (default: start a new conversation)",
+          "name": "conversation",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "user": {
+          "description": "Your end-user ID; send a stable value so per-user voice limits apply (default: generated per session)",
+          "name": "user",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "timezone": {
+          "description": "IANA timezone of the end user, used by the agent for time-aware answers",
+          "name": "timezone",
+          "default": "UTC",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "voice:start",
+      "pluginAlias": "chatbase",
+      "pluginName": "chatbase",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Start a voice session",
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "voice",
+        "start.js"
+      ]
+    },
     "whatsapp:send-template": {
       "aliases": [],
       "args": {
@@ -4317,5 +4424,5 @@
       ]
     }
   },
-  "version": "0.3.0"
+  "version": "0.4.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "chatbase",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "description": "The official command-line interface for the Chatbase API v2",
     "license": "MIT",
     "type": "module",
@@ -73,6 +73,9 @@
             "helpdesk": {
                 "description": "Look up helpdesk teams and ticket statuses"
             },
+            "voice": {
+                "description": "Start real-time voice sessions for an agent"
+            },
             "whatsapp": {
                 "description": "List WhatsApp templates and send template messages"
             },

package/spec/openapi.json

@@ -3173,6 +3173,65 @@
           "messageId"
         ]
       },
+      "VoiceSessionResponse": {
+        "type": "object",
+        "properties": {
+          "participantToken": {
+            "type": "string",
+            "description": "Short-lived token scoped to this session. Pass the response `data` to the Chatbase Voice SDK in your client; safe to hand to the browser or mobile app."
+          },
+          "sessionId": {
+            "type": "string",
+            "description": "The voice session ID."
+          },
+          "roomName": {
+            "type": "string",
+            "description": "The session room name, for correlating logs."
+          },
+          "maxDurationSeconds": {
+            "type": "integer",
+            "description": "Maximum session duration; the session ends automatically when it elapses."
+          },
+          "conversationId": {
+            "type": "string",
+            "description": "The conversation this session belongs to (echoed or generated)."
+          },
+          "userId": {
+            "type": "string",
+            "description": "The end-user ID for this session (echoed or generated)."
+          }
+        },
+        "required": [
+          "participantToken",
+          "sessionId",
+          "roomName",
+          "maxDurationSeconds",
+          "conversationId",
+          "userId"
+        ]
+      },
+      "VoiceSessionRequest": {
+        "type": "object",
+        "properties": {
+          "conversationId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Optional conversation UUID. Reuse a value to group multiple voice sessions into one conversation in chat logs. If omitted, a new conversation is created. A conversation belongs to the end-user who started it: when reusing, send that same userId or omit userId to inherit it. Sending a different userId is rejected with CONVERSATION_USER_MISMATCH, unless the conversation is still anonymous — then it is claimed by the userId you send."
+          },
+          "userId": {
+            "type": "string",
+            "maxLength": 128,
+            "pattern": "^[a-zA-Z0-9._-]+$",
+            "description": "Your end-user ID. Send a stable ID so per-user voice limits apply; if omitted a random one is generated per session (or inherited from the conversation when reusing a conversationId). Sessions with the same userId but no conversationId are separate conversations owned by the same end-user. Must contain only URL-safe characters (letters, digits, hyphens, underscores, dots)."
+          },
+          "timezone": {
+            "type": "string",
+            "maxLength": 64,
+            "default": "UTC",
+            "description": "IANA timezone of the end user (e.g. \"Europe/Paris\"), used by the agent for time-aware answers. Defaults to UTC."
+          }
+        }
+      },
       "ListConversationsResponse": {
         "type": "object",
         "properties": {
@@ -7458,6 +7517,177 @@
         }
       }
     },
+    "/agents/{agentId}/voice/sessions": {
+      "post": {
+        "operationId": "createVoiceSession",
+        "tags": [
+          "Agents"
+        ],
+        "summary": "Start a voice session",
+        "description": "Create a real-time voice session for an agent. Pass the response `data` to the Chatbase Voice SDK (`@chatbase-co/voice-sdk`) in your client: the SDK connects, publishes the microphone, and the agent joins automatically. Requires a plan with voice mode enabled; voice minutes consume message credits. Send `{}` when no options are needed.",
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "schema": {
+              "type": "string",
+              "minLength": 1,
+              "description": "The agent ID",
+              "example": "5QHA6VB-DIAbBhxwqxfdi"
+            },
+            "required": true,
+            "description": "The agent ID",
+            "name": "agentId",
+            "in": "path"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/VoiceSessionRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Voice session created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "$ref": "#/components/schemas/VoiceSessionResponse"
+                    }
+                  },
+                  "required": [
+                    "data"
+                  ]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The request body failed schema validation. Inspect the `details` object in the error response for field-level errors.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "VALIDATION_INVALID_BODY",
+                    "message": "Invalid request"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "No Authorization header present. Provide a valid API key as a Bearer token in the Authorization header: `Authorization: Bearer <api-key>`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "AUTH_MISSING_API_KEY",
+                    "message": "Authentication required"
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Your current plan does not include API access. Upgrade to the Standard plan or higher to use the API.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "SUBSCRIPTION_API_RESTRICTED_PLAN",
+                    "message": "A Standard plan or higher is required to access the API"
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "No agent matches the provided `agentId`, or it does not belong to the authenticated account.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "AGENT_NOT_FOUND",
+                    "message": "Agent not found"
+                  }
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "Rate limit exceeded. Check the `X-RateLimit-Reset` response header for the Unix epoch seconds when the limit resets.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "RATE_LIMIT_TOO_MANY_REQUESTS",
+                    "message": "Too many requests, please try again later"
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "An unhandled server error occurred. If the issue persists, contact support with the `x-request-id` response header value for debugging.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "INTERNAL_SERVER_ERROR",
+                    "message": "Something went wrong, please try again"
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Chatbase is undergoing scheduled maintenance and the API is temporarily rejecting requests. This is transient; retry after a short delay. Requests are rejected before any data is read or written, so no partial changes are applied.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": {
+                    "code": "SERVICE_UNDER_MAINTENANCE",
+                    "message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/agents/{agentId}/conversations": {
       "get": {
         "operationId": "listConversations",