Start a voice session

POST /sessions

Start a voice session: the conversation a rep is having with a customer, transcribed live from the audio the admin streams to GET /sessions/:sessionId/audio.

Name the draft quote it is about with orderId (it must be one: 404 VoiceQuoteNotFound, 409 VoiceQuoteNotDraft for an issued quote or an order, 502 VoiceQuoteUnavailable when fulfillment cannot be asked), or leave it out for a conversation before there is a quote. A session starts only after the rep has told everyone on the conversation that it is transcribed and they agreed: consent names the version of the notice the admin showed (notice) and says it was accepted. The organization needs the voice quoting add-on: 402 VoiceAddOnRequired without it. Appends voice.session-started. Keyed on sessionId, the caller-minted vcs_ id: a retry answers the session as it stands and appends nothing; the same id for another quote is 409 VoiceSessionConflict.

Access

Requires orders:write.

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

Retries

Keyed on sessionId, the caller-minted vcs_ id: a retry answers the session as it stands and appends nothing; the same id for another quote is 409 VoiceSessionConflict.

A retry with the same key answers 201, with what the first call recorded.

Why every write carries a key: Idempotency and retries.

Facts appended

voice.session-started

What a fact is: Facts and the journal.

AI agent tool

No agent tool. A voice session listens to the rep's microphone on the quote page, once the rep has shown the customer the consent notice; an agent cannot hold a microphone, and hears a conversation as voice.utterance-heard on the tenant's stream.

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://voice.getmanifold.io/sessions' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33",
  "orderId": "ord_01a15a33-19a4-7b5d-b0e1-2c7f6a8d9e44",
  "consent": {
    "notice": "2026-10-28",
    "accepted": true
  }
}'

JavaScript (fetch)

const response = await fetch("https://voice.getmanifold.io/sessions", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "sessionId": "vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33",
    "orderId": "ord_01a15a33-19a4-7b5d-b0e1-2c7f6a8d9e44",
    "consent": {
      "notice": "2026-10-28",
      "accepted": true
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "sessionId": "vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33",
  "orderId": "ord_01a15a33-19a4-7b5d-b0e1-2c7f6a8d9e44",
  "consent": {
    "notice": "2026-10-28",
    "accepted": true
  }
}

Response · 201 · application/json

{
  "id": "vcs_01a15a32-7d10-7f3b-a2c6-4e8b1d0f5c33",
  "status": "listening",
  "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"
}

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`

Refusal	What it means	What 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`

Refusal	What it means	What to do
`VoiceAddOnRequired` reason	The request was refused. `reason` says why.	Nothing changed.
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What 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`

Refusal	What it means	What to do
`VoiceQuoteNotFound` orderId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`VoiceQuoteNotDraft` orderId, status	The request was refused, and nothing changed.	Nothing changed. Read the record, then decide.
`VoiceSessionConflict` sessionId, reason	The request was refused. `reason` says why.	Nothing changed. Read the record, then decide.
`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.

`502`

Refusal	What it means	What to do
`VoiceQuoteUnavailable` reason	Fulfillment cannot be asked, or leave it out for a conversation before there is a quote.	Send the same request again, with the same key.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again, with the same key.

How refusals work everywhere: Errors.