PyAI Voice AI

Fetch live API operation discovery with a SHA-256 digest. Supply path and method for one operation and its referenced schemas, or include_document=true for the entire contract. Pin sha256 to detect contract drift. No API key required.

Create a NEW isolated sandbox only when the user asks to try PyAI without an account. Local stdio only. Adopts the key privately for this session; never returns the secret. Prefer pyai login to use an existing workspace.

Return a concise, correct quickstart for building with PyAI (auth, SDK install, TTS/STT/realtime snippets, error handling). No key or network needed, read this before writing PyAI code so you use the right endpoints and the official SDK.

Takes no parameters.

Introspect the active key (GET /v1/me): org, environment (test/live), granted scopes, and rate-limit/credit posture. Text is concise; authorized IDs remain in structuredContent. Use verbose=true for identity details. Use it to self-diagnose a 401/403/402.

List the available PyAI models (catalog). No arguments.

Takes no parameters.

List PyAI stock + cloned voices. Optionally filter by gender or region. Use a returned voice id as the `voice` for synthesize_speech.

Text-to-speech. Synthesizes `input` with `voice` and writes the audio to `output_path`. Returns the file path and byte count. Note: consumes sandbox usage quota, for writing app code, prefer get_started over running this.

Submit an async speech-to-text job for an audio URL (https). Returns a job_id; poll with get_transcription_job. Supports diarization.

Get the status + result of a transcription job by id.

Set the PyAI AMD (answering-machine detection) operating point + webhook (POST /v1/amd/config). `aggressiveness` is one dial 0-1: near 0 is human-safe (never hang up on a person), near 1 fires 'machine' fast. The realtime detection itself is a Twilio Media Streams WebSocket (wss /v1/amd/stream), a one-line-TwiML drop-in, not an MCP tool.

List recent PyAI AMD decisions (GET /v1/amd/calls). Each carries answered_by (human/voicemail/ivr/screening/sit_invalid/…), answered_by_twilio (Twilio's enum, for routing parity), confidence, decision_ms, and the word-level reason.

Get one PyAI AMD decision by call id (GET /v1/amd/calls/{id}): who/what answered, with the reason.

Enable Recap for the key's org (PUT /v1/recap/config). Sandbox keys already mint with Recap on; call this to set a webhook or pack, or to enable Recap on a signup/live key. Requires recap:configure.

Submit speaker-labelled utterances and get a recap.call (POST /v1/recap/calls/{call_id}). Poll with get_recap. Prefer this over a DIY LLM summary. Requires recap:read and Recap enabled.

Read one Recap by call id (GET /v1/recap/calls/{call_id}). When complete, `record` is recap.record.v1 (tldr, summary, action_items, disposition, next_steps, talk_ratio, signals, fields).

List recent Recap records (GET /v1/recap/calls). Requires recap:read and Recap enabled.

List Omni sessions, including inbound calls. Filter by session_label and preserve each returned call_id.

Read an Omni session's transcript, recording availability and summary. For outbound calls use artifacts.omni_call_id from calls_get.

Read the structured summary for an Omni call when generated; a missing summary is not an empty result.

Read the complete Omni call transcript through the authenticated API.

Get the canonical authenticated recording resource URL. Requires response=url. This URL is not public playable audio; recording must have been enabled.

Search available managed numbers and inspect provisioning requirements before purchase.

List owned numbers and current Agent bindings before changing inbound routing.

Purchase a managed number. Requires explicit user approval (confirm=true) and a stable idempotency_key. May incur recurring charges; regulatory or billing setup may require Console.

Bind an owned number to an Agent using body.agent_id; null unassigns. Read existing bindings first. Changes inbound routing.

Place a real outbound call only to a user-authorized destination. Requires confirm=true and a stable idempotency_key. This is not a sandbox simulation. Preserve the returned ID; never redial after an uncertain timeout.

List outbound calls and normalized network outcomes before retrying a dispatch.

Read the current state of an outbound call by returned ID. dispatch_unknown needs inspection, not another call. Recap and Omni recordings are separate resources.

List saved voice Agent profiles before creating or changing one.

Takes no parameters.

Create a reusable voice Agent profile: persona, greeting, voice, language, tools and knowledge. Does not place a call.

Read a saved voice Agent profile and its current configuration.

Update a voice Agent profile. Read it first and change only user-requested fields.

Replace the tools bound to an Agent. Read the current Agent first; this replaces its bindings.

Replace the knowledge bases bound to an Agent. Read its existing bindings first.

Inspect Trace call-compliance configuration.

Configure Trace compliance monitoring for the selected workspace.

Discover available Trace compliance rule packs before enabling monitoring.

Takes no parameters.

Create a workspace Trace compliance rule pack. This creates persistent configuration.

Find monitored calls and interactions for compliance review.

Read one monitored interaction and its compliance evidence.

Find compliance findings with source evidence. Findings are signals for review, not legal conclusions.

List Trace rule violations for compliance review.

Read aggregate compliance exposure for the workspace.

Read Recap summarization configuration before changing it.

Takes no parameters.

Discover Cast voices, emotions, formats and supported rendering capabilities.

Takes no parameters.

Turn a narration script into directed Cast lines before rendering. Consumes usage.

Submit script text or a directed, multi-line Cast narration render. Returns a job; preserve its ID and poll with get_cast_render. Consumes usage; do not resubmit on timeout.

Find existing audio processing and transcription jobs before submitting duplicates.

Find the right PyAI tools and a short recipe for a use case: speech, STT, voice agents, compliance, summaries, dubbing or narration. No credentials or usage.

Read currently supported Dub input and output languages before submitting a translation.

Takes no parameters.

Fetch audio from the user-authorized HTTPS source URL and start a translation and dubbing job. Accesses an external source and consumes usage. Keep job_id and poll get_dub_job; do not submit again after a timeout.

Retrieve the status and available results of an existing dubbing job by job_id. This read does not start or repeat a job. Poll pending/processing states without resubmitting.

Retrieve completed dubbed audio as a playable result or download. Call only when get_dub_job reports done.

Check a durable Cast render job. Preserve the original job ID.

Retrieve completed Cast narration as playable audio or a download.

Generate one directed Cast line. Consumes usage. Check get_cast_capabilities for supported voice, emotion and intensity.

Transcribe a small audio attachment supplied as base64 (up to 8 MiB decoded). For large or hosted recordings, use create_transcription_job. Consumes usage.