Voice API · sessions

Stop listening: the audio connection

POST /sessions/{sessionId}/end

Stop listening: the audio connection, if one is open, is closed, and the session ends with the audio it transcribed — whole minutes, rounded up, are what the add-on is metered by.

Appends voice.session-ended (reason stopped), then — for a session on a quote — hands the transcript to fulfillment, which keeps it on the order (fulfillment.transcript-attached, read through POST /orders/:orderId/transcripts/:sessionId/link), and appends voice.transcript-saved naming it; a session that made no quote keeps no transcript. A session nobody stops is ended the same way by the service's sweep, two minutes after its audio stopped arriving (reason disconnected). 404 VoiceSessionNotFound. Idempotent by state: a session ends once, and ending an ended one answers it as it is and appends nothing.

Access

Requires orders:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by state: a session ends once, and ending an ended one answers it as it is and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

  • voice.session-ended
  • voice.transcript-saved

What a fact is: Facts and the journal.

AI agent tool

No agent tool. Stopping a conversation the rep is having is the rep's control on the quote page; a session nobody stops is ended by the service's sweep once its audio has gone.

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://voice.getmanifold.io/sessions/vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33/end' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://voice.getmanifold.io/sessions/vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33/end", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Response · 200 · application/json
{
  "id": "vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33",
  "status": "ended",
  "orderId": "ord_01a15a33-19a4-7b5d-b0e1-2c7f6a8d9e44",
  "source": {
    "kind": "browser",
    "channels": 1
  },
  "consent": {
    "notice": "2026-10-28",
    "accepted": true
  },
  "startedBy": "usr_01a15a31-0b7e-7a12-8d44-6c5e2b9f1a20",
  "startedAt": "2026-10-28T03:10:00.000Z",
  "endedAt": "2026-10-28T03:16:41.000Z",
  "endReason": "stopped",
  "audioSeconds": 371,
  "billableMinutes": 7,
  "utterances": 42,
  "transcript": {
    "utterances": 42,
    "bytes": 4180,
    "savedAt": "2026-10-28T03:16:42.000Z"
  }
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: voice-manager.openapi.json. Base URL https://voice.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

404

RefusalWhat it meansWhat to do
VoiceSessionNotFound sessionId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.