Documentation Index
Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt
Use this file to discover all available pages before exploring further.
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Agent with attached tools
prompt (default, legacy): a single system_prompt drives the call; the LLM decides when to call attached tools. flow: the call is driven by a flow_config graph of conversation, tool-call, and routing nodes. type is immutable post-create — to change types, create a new agent.
prompt, flow The flow graph. Required when type='flow', must be omitted/null when type='prompt'.
Michal, Yonatan, David, Rachel, Gil, Noa, Maya, Adam, Shira, Avigail, Amir, Liat, Omer, Tamar, Tom, Benny, Nir, Natan, Yael, Dvora, Yosef, Shir, Anat, Ariel, Roi, Shlomo, Dana, Alon, Ruth, Yuval Ambient background sound mixed under the agent's voice during calls. Null means silent (default).
call_center, open_office, cafe, outdoor Volume of the background sound, 0.0–0.6. Capped to protect turn-taking.
0 <= x <= 0.6he, en 0 <= x <= 2Seconds of silence before VAD confirms speech has stopped
0.05 <= x <= 5Seconds of speech before VAD confirms speech has started
0.05 <= x <= 2Minimum confidence threshold for voice detection
0 <= x <= 1Seconds of caller silence before auto-hangup. Prevents idle calls wasting credits.
10 <= x <= 900Max seconds one party can speak non-stop before auto-hangup. Catches answering machines. 0 = disabled.
0 <= x <= 300Hard cap on total call duration regardless of activity. 0 = disabled.
0 <= x <= 3600When true, the matched lead's long-term memory context is injected into the system prompt at call time.
call.started, call.answered, call.ended, call.failed, call.no_answer, call.dnc_blocked, transcript.ready, call.analyzed AI extraction parameters — after each call, values are extracted from the transcript and included in the call.analyzed webhook payload (and stored on the call log).