Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Voice

Knowledge Search

Approved snippets from the workspace knowledge base. Never fails the call: when search can't run (free-tier quota used up, embeddings not configured, provider error) it returns no snippets and a ``reason``, and the agent promises a follow-up instead of guessing.

API key access

This route has its own authentication (or none); an API key is not used here.
POST/api/v1/calls/{call_id}/knowledge/search

Authorization

AuthorizationBearer <token>

Per-call token issued when the call was created (job metadata api_token).

In: header

Path Parameters

call_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Workspace of the call (must match the token).

Request Body

querystring
Length1 <= length <= 1000

Response Body

curl -X POST "http://localhost:8000/api/v1/calls/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge/search" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{
  "snippets": [
    {
      "text": "string",
      "source": ""
    }
  ],
  "reason": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

End Test Call

Hang up a browser test call (admin+): deletes its LiveKit room, which disconnects the browser and the agent; the agent then completes the call (outcome and transcript). `ended: false` when the room was already gone.

Opt Out

Suppress the lead (phone + every channel per policy) and stop their sequences. Idempotent; accepted even after the call completed.