メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.oneinbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

概要

約 15 分で動作する音声エージェントを作成し、Web 通話を開始します。電話番号・テレフォニーキャリア・サードパーティ API キーは不要です。 行うこと:
  1. LLM モデルを作成
  2. エージェントを作成
  3. POST /v1/calls/webWeb 通話を作成
所要時間: 約 15 分 すべてのリクエスト:
Authorization: Bearer <api_key>

前提条件

項目取得先
OneInbox API キーダッシュボードAPI KeysCreate API key
ターミナルcurl(Mac、Windows PowerShell、WSL)
API キーをコピーし、以下の curl すべてで Authorization: Bearer <api_key> を使用します。詳細 → 認証 各ステップの実行方法: ターミナル(Mac)、PowerShell、または WSL を開きます。curl コマンドをコピーし、プレースホルダー(例: <api_key> → 実際のキー)を置き換え、ターミナルに貼り付けて Enter を押します。JSON レスポンスに "id" があれば成功です。 電話番号・ベンダー連携は不要です。インテグレーションは BYOK やテレフォニーキャリアが必要な場合のみ任意です。

1) LLM を作成

エージェントの「頭脳」 — デフォルト LLM とシステムプロンプトを定義します。ステップ 2 のエージェントは llm_id でこのモデルを参照します。
フィールド意味このガイド
nameダッシュボード上のラベル"My First Model"
providerLLM 設定デフォルト LLM
modelLLM 設定デフォルト LLM
system_promptエージェントの指示性格とルール
temperature創造性(0=厳密、1=創造的)0.7
tool_idsツール[]
knowledge_base_idsナレッジベース[]
curl -X POST https://api.oneinbox.ai/v1/models \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Model",
    "provider": "openai",
    "model": "gpt-4.1-mini",
    "system_prompt": "You are a friendly assistant. Keep every response under two sentences. Be warm and direct.",
    "temperature": 0.7,
    "max_tokens": 4000,
    "tool_ids": [],
    "knowledge_base_ids": []
  }'
{
  "id": "model_abc123",
  "name": "My First Model",
  "system_prompt": "You are a friendly assistant...",
  "temperature": 0.7,
  "created_at": "2026-01-15T10:02:00Z"
}
エラー意味対処
401API キー誤りダッシュボードから完全なキーをコピー
400モデル設定が無効上記 JSON に合わせる
レスポンスの "id"(例: model_abc123)をコピーします。ステップ 2 の <llm_id> に貼り付けます。

2) エージェントを作成

音声エージェント全体 — STT、LLM、TTS、通話ルールを組み立てます。ステップ 1 の llm_id を指定します。 以下の curl の <llm_id> を、ステップ 1 でコピーした "id" に置き換えます。
部分フィールドこのガイド
頭脳llm_idステップ 1
耳(STT)transcriberデフォルト STT
声(TTS)ttsデフォルトボイス
振る舞いfirst_message、タイムアウト挨拶と切断ルール
フィールド動作
first_message通話開始時の最初の発話
end_call_phrasesユーザーが言うと通話終了
silence_timeout_seconds無音が続いたら切断
max_duration_seconds通話時間の上限
interruption_sensitivity割り込みのしやすさ(0.0–1.0)
enable_recordingtrue で録音
curl -X POST https://api.oneinbox.ai/v1/agents \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support Agent",
    "llm_id": "<llm_id>",
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-3",
      "language": "en"
    },
    "tts": {
      "provider": "deepgram",
      "voice_id": "asteria",
      "speed": 1.0,
      "stability": 0.5
    },
    "first_message": "Hi! How can I help you today?",
    "end_call_phrases": ["goodbye", "bye", "that is all"],
    "silence_timeout_seconds": 10,
    "max_duration_seconds": 600,
    "interruption_sensitivity": 0.6,
    "enable_recording": false
  }'
{
  "id": "agent_abc123",
  "name": "Support Agent",
  "llm_id": "model_abc123",
  "first_message": "Hi! How can I help you today?",
  "created_at": "2026-01-15T10:03:00Z"
}
エラー意味対処
404 on llm_idLLM ID 誤りステップ 1 から再コピー
400transcriber/tts 設定誤り上記 JSON を使用
レスポンスの "id"(例: agent_abc123)をコピーします。ステップ 3 の <agent_id> に貼り付けます。

3) Web 通話を作成

Web 通話 — OneInbox 上の音声セッションを API で作成します(POST /v1/calls/web)。このステップは API のみです。call_id を返し、ステータスとトランスクリプトはポーリングで取得します。 <agent_id> をステップ 2 でコピーした "id" に置き換えます。
curl -X POST https://api.oneinbox.ai/v1/calls/web \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<agent_id>",
    "variables": { "customer_name": "Guest" }
  }'
{
  "id": "call_abc123",
  "server_url": "wss://voice.oneinbox.ai",
  "participant_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
フィールド意味
id通話 ID — GET /v1/calls/<call_id> でポーリング
server_urlWebSocket URL(Web SDK 用)
participant_tokenWeb SDK 用クライアントトークン — API キーではない
エラー意味対処
404 on agent_idエージェント ID 誤りステップ 2 から再コピー
完了の確認: レスポンスに "id""server_url""participant_token" があれば Web 通話セッションの作成に成功しています。このステップでは マイクはまだ使えません — OneInbox 上にセッションを作るだけです。 ブラウザでエージェントと 聞き・話す には Web SDK へ進んでください。通話ステータスを確認する場合:
curl https://api.oneinbox.ai/v1/calls/<call_id> \
  -H "Authorization: Bearer <api_key>"
"status": "completed" になるまで待ち、transcript を確認します。

次のステップ

電話番号を連携して実番号に発信・着信 — 電話通話

電話通話

キャリア連携、番号登録、アウトバウンド・インバウンド

インテグレーション

キャリア認証情報を OneInbox に保存

Web SDK

Web 通話のブラウザ音声

ツール

API 呼び出し、転送、切断