コマンドラインから音声エージェントを作成、デプロイ、管理します。
インストール
クイックインストールのコマンドを実行することにより、Cartesia の
利用規約 (TOS) に同意したものとみなされます。続行する前に必ず利用規約の全文を確認してください。
サーバーからインストールおよびダウンロードします:
curl -fsSL https://cartesia.sh | sh
最新バージョンへ更新します:
クイックスタート
API キーでログイン
Cartesia API キーで認証します。
API キーを作成するには play.cartesia.ai/keys にアクセスし、組織を選択してください。cartesia auth login # paste your API key when prompted
サンプルエージェントをクローン
Line リポジトリからサンプルエージェントをクローンします。cartesia create my-agent
# Choose any example you like.
cd my-agent
エージェントをデプロイ
エージェントをデプロイしてプレイグラウンドで利用できるようにします。
プロジェクトの初期化
任意のディレクトリを新規または既存の Cartesia エージェントにリンクします:
サンプルからプロジェクトを作成します:
プロジェクトディレクトリ内では、CLI が自動的にエージェントを検出します。現在のエージェント ID を確認するには cartesia status を実行します。
エージェントとチャット
エージェントのテキスト推論をローカルでテストします。
ターミナル 1:テキストロジックの FastAPI サーバーを実行します。
PORT=8000 uv run python main.py
ターミナル 2:CLI を実行してエージェントとチャットします。
コマンド
API キーを取得するには、play.cartesia.ai/keys にアクセスし、組織を選択して新しいキーを生成してください。
既存の API キーを検証します:
ログアウト(キャッシュされた認証情報をクリア):
音声エージェント
エージェントを Cartesia クラウドにデプロイします。
組織内のすべてのエージェントを一覧表示します:
マネージドデプロイメント
Cartesia のクラウド上で実行されるエージェントのバージョンです。各デプロイメントは環境を再ビルドし、プロジェクトをインスタンス化し、ヘルスチェックを実行します。
すべてのデプロイメントを表示します:
デプロイメントのステータスを確認します:
cartesia status [<deployment-id> or <agent-id>]
セルフホスト型エージェントコード
Cartesia のマネージドデプロイメントは低レイテンシの音声エージェントをデプロイする最も簡単な方法ですが、エージェントコードのデプロイメントをご自身で管理したい場合は、通話中にエージェントが接続する URL を Cartesia に渡すこともできます。
既存のエージェントをセルフホスト型コードに接続します:
cartesia connect --agent-id <agent-id> --url https://my-agent.example.com
--agent-id を指定せずに実行すると、既存のエージェントを対話的に選択するか、新規作成できます:
cartesia connect --url https://my-agent.example.com
エージェントをセルフホスト型コードから切断します:
cartesia disconnect --agent-id <agent-id>
環境変数
エージェント用の環境変数を作成、一覧表示、削除します。
エージェントに環境変数を設定します:
cartesia env set API_KEY=FOOBAR MY_CONFIG=FOOBAZ
環境変数は保存時に暗号化され、お客様のコードからのみアクセスできます。
.env ファイルから環境変数を取り込みます:
cartesia env set --from .env
API_KEY=FOOBAR
MY_CONFIG=FOOBAZ
環境変数を削除します:
cartesia env rm <env-var-name>
電話番号
組織内のすべての電話番号を一覧表示します:
cartesia phone-numbers ls
プロバイダーの種類または割り当てられたエージェントでフィルタリングします:
cartesia phone-numbers ls --type twilio # cartesia, twilio, or sip_trunk
cartesia phone-numbers ls --agent-id <agent-id>
特定の電話番号の詳細を取得します:
cartesia phone-numbers get <phone-number-id>
新しい Cartesia マネージドの電話番号をプロビジョニングします:
cartesia phone-numbers provision "Support Line"
cartesia phone-numbers provision "Support Line" --agent-id <agent-id>
電話番号をエージェントに割り当てます:
cartesia phone-numbers assign <phone-number-id> --agent-id <agent-id>
電話番号のエージェント割り当てを解除します:
cartesia phone-numbers unassign <phone-number-id>
電話番号のラベルを更新します:
cartesia phone-numbers update <phone-number-id> --label "New Label"
電話番号を削除します:
cartesia phone-numbers delete <phone-number-id>
ヘルプメニュー
各コマンドの詳細を確認するには: