Skip to main content
POST
/
v1
/
voice
/
calls
Ingest a voice call (ASR + PII scrub + optional audio retention)
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/voice/calls \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'audio=<string>' \
  --form 'metadata=<string>'
{
  "call": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "external_id": "<string>",
    "channel": "<string>",
    "duration_ms": 123,
    "audio_mime_type": "<string>",
    "audio_retention_policy": "<string>",
    "scrub_status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "transcript": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "voice_call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "full_text": "<string>",
    "was_scrubbed": true,
    "scrub_detection_count": 123,
    "language": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "audio_url": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
audio
string
required

Voice call audio (PCM WAV recommended)

metadata
string
required

JSON object with keys: channel (str, required), external_id (str, optional), language (str, optional, default "en"), metadata (object, optional)

Response

Successful Response

call
VoiceCallSummary · object
required
transcript
VoiceTranscriptOut · object
required
audio_url
string | null