Talk with your agents. A voice call in the browser that your agent can start or join.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Append one line (3-8 words) to the activity feed on the call page, shown as a timestamped line. Never spoken. context and faq: hidden background of this line for the voicebot.
3-8 words.
The `session` value returned by join.
Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot.
Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Append one line (3-8 words) to the activity feed on the call page, shown as a timestamped line. Never spoken. context and faq: hidden background of this line for the voicebot.
| Argument | Type | Description |
|---|---|---|
| faq | any | Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. |
| text* | string | 3-8 words. |
| context | any | Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
}
},
"title": "activityArguments",
"required": [
"session",
"text"
],
"properties": {
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot."
},
"text": {
"type": "string",
"title": "Text",
"description": "3-8 words."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}Teach the call's speech recognition words it keeps mishearing (product names, people, jargon). Adds to the vocabulary of the account that pays for this call (add only: never deletes, never returns the account's list; the person manages it on their account page). terms: words to recognize; fixes: {wrong, right} = a known mishearing and the correct word (right is added to the terms too). Max 20 entries per call of this tool, 100 per call, 50 characters each. Corrections apply right away, the word list from the next sentence or the next call. 409: guest call without an account. Returns added {terms, fixes}, total, call_left, reloaded.
| Argument | Type | Description |
|---|---|---|
| fixes | any | Known mishearings: [{"wrong": "Erzähli", "right": "Trello"}]. |
| terms | any | Words or short phrases to recognize, e.g. ["Trello"]. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "add_vocabArguments",
"required": [
"session"
],
"properties": {
"fixes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
{
"type": "null"
}
],
"title": "Fixes",
"default": null,
"description": "Known mishearings: [{\"wrong\": \"Erzähli\", \"right\": \"Trello\"}]."
},
"terms": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Terms",
"default": null,
"description": "Words or short phrases to recognize, e.g. [\"Trello\"]."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}Phone the human who owns this call on their own confirmed phone number, e.g. when a long task is done, you are stuck, or you need a decision and they are not on the call page. You never pass a number. Their account rules decide (opt-in, allowed reasons, quiet hours, calls per day, budget, credit); a refusal returns {status: refused, why}. Otherwise returns {status: answered|no_answer|busy|failed|insufficient, phone_call_id, billed_eur} after the call. reason: done | blocked | decision. message: max 200 characters, said when they pick up.
| Argument | Type | Description |
|---|---|---|
| reason* | string | Why you call: done, blocked or decision. |
| message | any | Optional: what to tell them when they pick up, max 200 chars. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "call_meArguments",
"required": [
"session",
"reason"
],
"properties": {
"reason": {
"enum": [
"done",
"blocked",
"decision"
],
"type": "string",
"title": "Reason",
"description": "Why you call: done, blocked or decision."
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message",
"default": null,
"description": "Optional: what to tell them when they pick up, max 200 chars."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}Start a new voicehook.ai voice call. `lang` = the language of the person being called (de or en, default de). Returns `human_url` (the link for the person; whoever opens it starts the call, on their own free allowance or credit), `share_text` (a ready message with human_url and the hint that the link needs a normal browser, because an app's built-in browser blocks the microphone), `operator_invite_url` (the agent's own link for `join`), `room` and `expires_in` (seconds until an unopened link expires, 30 min); `local_cli_hint` only for a local client with a shell (Claude Code, Cursor, VS Code and similar). join with operator_invite_url waits for the person (up to 200 s in Claude clients, else 50 s) and returns waiting_for_human with `next_action` until they open human_url; it can be repeated until the link expires (410), also from a background job over the HTTPS bridge. Errors: 429 = too many new calls right now. Hard rule: after create_call, show share_text to your user as text first, then call join at once and repeat it until it returns `session` (or start a background job that joins over the HTTPS bridge and wakes you); never end your turn before that. Then keep calling next in a loop.
| Argument | Type | Description |
|---|---|---|
| lang | string | Language of the person you are calling (default de). |
| mode | string | |
| name | any | Optional label for your own reference (not shown in the call; your name in the call comes from join). |
| solo | any | true or left out (default) = solo call: the voicebot speaks as each joining agent, every agent in its own voice and in first person; more agents may join (e.g. a second model next to you). false = the voicebot speaks as itself and announces the agents. |
Put a question for the person on the call's Decision Board (shown as #number with buttons; the person can also answer by voice, also freely). Meant for every question the person decides: yes/no, A/B, an approval, picking a value. A question only spoken via say leaves no button and no decision event. Without options it is a yes/no question (buttons Yes/No); options: 2 to 3, max 40 characters each, recommend = index of the recommended option. question: max 160 characters. Longer or more: 422, never cut. Returns id and number. The answer arrives later as a `next` event {type: decision, id, number, verdict: yes|no|option|other|unclear, option?, text? (their own answer, or for unclear the request to ask it again more simply), by}. context: the background the person opens with the arrow next to the question on the card and Delta uses to explain it, only what the reader needs, nothing internal, one short line per part (Was / Warum / Bei Ja / Bei Nein, or What / Why / If yes / If no; lines starting with '- ' show as bullet points); faq: the 3 likely follow-up questions with prepared answers, shown below it as questions and answers. Without context and faq the card shows no arrow; without context and 3 faq the result carries `warnings` (no error). Change an open one with id plus new fields, remove it with id and delete true. no_question = id of a question_check event, alone: confirms that line was no question to the person. Decisions marked auto (detected automatically) are answered only by a human; changing or deleting them gives 403.
| Argument | Type | Description |
|---|---|---|
| id | any | Id of an open decision to change or delete. |
| faq | any | Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. Without context and 3 faq the result carries `warnings`. |
| delete | boolean |
Lists every OPEN decision on the call's Decision Board, from all agents in the call and their helper sessions (relay, MCP, bridge), oldest number first. Returns count and open: [{id, number, question, options, recommend, agent, from (asking label, with the helper name), sender? (helper session), state, at (created, epoch), age_s, mine (asked by this session or one of its helpers), context? (background, also shown on the card behind the arrow)}]. Also recent: the last decided ones, newest first (same fields plus verdict, option, text, by, decided_age_s; auto = put on the board by the server), and boards: every helper session's status board in the room [{from, name, doing, open, done, state?, age_s (since its last update), meta? (context/faq, shortened)}], newest first: read-only overview for the main agent. Errors: 503 = voicebot not (yet) in the call.
| Argument | Type | Description |
|---|---|---|
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "decisionsArguments",
"required": [
"session"
],
"properties": {
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}For a helper session that is not in the call: appends one line (3-8 words) to the call's activity feed as 'Helper <label>: <helper_name>: <text>'. Never spoken verbatim. context and faq: hidden background of this line for the voicebot. Returns the line.
| Argument | Type | Description |
|---|---|---|
| faq | any | Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. |
| text* | string | 3-8 words. |
| context | any | Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page. |
| credential* | string | Helper credential `token` from helper_credential or POST /api/helper/credential. |
| helper_name* | string | Name of this helper session, 1-40 chars (shown on the call page as `from`). |
{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
}
},
"title": "helper_activityArguments",
"required": [
"credential",
"helper_name",
"text"
],
"properties": {
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot."
},
"text": {
"type": "string",
"title": "Text",
"description": "3-8 words."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page."
},
"credential": {
"type": "string",
"title": "Credential",
"description": "Helper credential `token` from helper_credential or POST /api/helper/credential."
},
"helper_name": {
"type": "string",
"title": "Helper Name",
"description": "Name of this helper session, 1-40 chars (shown on the call page as `from`)."
}
}
}For the agent in the call (`session`): returns a helper credential `token` (with `url` and `expires_in`) that lets other sessions working for the same person add their own status board, decisions and activity lines to this call without joining (no voice, no chip). `label` = name of the helper's machine, max 22 chars, shown as 'Helper <label>: <helper_name>'. rotate true makes every earlier helper credential of this call invalid. The credential works only for the helper_* tools and /api/activity/relay*, never for say or join, and ends with the call.
| Argument | Type | Description |
|---|---|---|
| label* | string | Machine label of the helper, max 22 chars. |
| rotate | boolean | true = invalidate earlier helper credentials. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "helper_credentialArguments",
"required": [
"session",
"label"
],
"properties": {
"label": {
"type": "string",
"title": "Label",
"description": "Machine label of the helper, max 22 chars."
},
"rotate": {
"type": "boolean",
"title": "Rotate",
"default": false,
"description": "true = invalidate earlier helper credentials."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}For a helper session that is not in the call: puts its own question on the Decision Board, shown with the sender 'Helper <label>: <helper_name>'. Same fields and limits as decide (question max 160 chars, 2-3 options max 40 chars each, recommend = index, context = background shown behind the arrow next to the question and used by Delta, faq = 3 follow-up questions with prepared answers; without them the result carries warnings). Change or delete only own questions (same credential and from), else 403. Returns id and number; the answer comes from helper_next, never from the main agent's next.
| Argument | Type | Description |
|---|---|---|
| id | any | Id of an own open decision to change or delete. |
| faq | any | Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. Without context and 3 faq the result carries `warnings`. |
| delete | boolean | true = remove the decision `id`. |
| context | any | Background (max 1500 chars) the person opens with the arrow next to the question; Delta explains from it. Only reader-relevant, one line per part: Was / Warum / Bei Ja / Bei Nein. |
| options | any | Optional: 2 to 3 answer options, max 40 characters each. |
| question | any | The question, max 160 chars (required when creating). |
For a helper session that is not in the call: returns the answers to its own questions (same credential and helper_name) as events [{type: decision, id, number, verdict: yes|no|option|other, option?, text?, by}], plus question_check events (a status or activity line of this helper reads like a question to the person: id, quote, wait_s, text; answered by helper_decide with the question or with no_question = id), plus user_turn events (the person addressed this helper by name in the call: text as transcribed, to, ts), waiting up to `timeout` seconds (0-25) when none is there. At most 50 kept per helper, gone when the call ends.
| Argument | Type | Description |
|---|---|---|
| timeout | number | Seconds to wait, 0-25. |
| credential* | string | Helper credential `token` from helper_credential or POST /api/helper/credential. |
| helper_name* | string | Name of this helper session, 1-40 chars (shown on the call page as `from`). |
{
"type": "object",
"title": "helper_nextArguments",
"required": [
"credential",
"helper_name"
],
"properties": {
"timeout": {
"type": "number",
"title": "Timeout",
"default": 0,
"maximum": 25,
"minimum": 0,
"description": "Seconds to wait, 0-25."
},
"credential": {
"type": "string",
"title": "Credential",
"description": "Helper credential `token` from helper_credential or POST /api/helper/credential."
},
"helper_name": {
"type": "string",
"title": "Helper Name",
"description": "Name of this helper session, 1-40 chars (shown on the call page as `from`)."
}
}
}For a helper session that is not in the call: puts a card on the person's call page (never spoken), shown with the sender 'Helper <label>: <helper_name>'. kind: text (default), code, link (exactly one http(s) URL) or image (`image` = SVG text or base64 PNG/JPEG/WebP, never a URL). Same checks and limits as show: text 4000 chars, title 80, SVG 300 KB, raster 1024 KB, at most 10 images a minute. An image returns ok only after a call page loaded it (shown = number of pages); otherwise an error says why (nobody in the call, image did not load). Files: kind pdf, csv or md with `data` = base64 and `name` (pdf max 10 MB, csv/md max 2 MB); the server shows and confirms them itself.
| Argument | Type | Description |
|---|---|---|
| data | any | kind pdf, csv or md: the file as base64. |
| kind | any | |
| name | any | kind pdf, csv or md: file name. |
| text | any | Card text, max 4000 chars (code: the code; link: the URL). |
| image | any | kind image: SVG text or base64 PNG/JPEG/WebP (SVG max 300 KB, raster max 1 MB). |
| title | any | Optional title, max 80 chars. |
| credential* | string | Helper credential `token` from helper_credential or POST /api/helper/credential. |
| helper_name |
For a helper session that is not in the call: sets its own status board on the call page, shown as 'Helper <label>: <helper_name>' below the main agent; the main agent's board stays as it is. Same limits as status (doing max 400 chars, open / done max 10 items). meta: Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error). Empty doing, open and done removes the helper's board. Returns ok and, when context or faq is missing on an entry, warnings.
| Argument | Type | Description |
|---|---|---|
| done | any | Done items, max 10. |
| meta | any | Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error). |
| open | any | Open items, max 10. |
| doing | string | Current step + ETA, max 400 chars. |
| credential* | string | Helper credential `token` from helper_credential or POST /api/helper/credential. |
| helper_name* | string | Name of this helper session, 1-40 chars (shown on the call page as `from`). |
Connect to a voicehook.ai voice call as the agent behind its voicebot. invite_url: the full invite link including ?invite= (from the person or from create_call). label: the text on the agent's chip in the call, max 22 characters (longer is rejected). model: the model id the agent runs on (internal, not shown). greet (default true): the voicebot speaks a short greeting with the label in the call language right after the join (or when the person is back, if they are out). Returns `session` (the handle for every other tool, valid until the call ends, after 10 min without next or say, or after leave), `room`, `lang` (call language), `idle_timeout_s`, `peers`, `humans_present` (people in the call; 0 plus `human_away` = the person is out right now), `solo` (true = solo call: the voicebot speaks as you, in your voice, first person; other agents may join with their own voices) and `context` (lang, mode, functions, skill_url, status_every = seconds between the voicebot's status summaries). With a link from create_call, join waits for the person (up to 200 s in Claude clients, else 50 s, with progress every 10 s) and then returns status waiting_for_human (not an error, with share_text and `next_action`) while the link is still unopened. `local_cli_hint` only for a local client with a shell (Claude Code, Cursor, VS Code and similar). Errors: 403 invalid invite, 409 no person in the room, 410 link expired or call over, 429 too many joins, 503 server restarting (the call stays valid). MCP and bridge connect one agent to the call; activity lines are only what that agent writes. For several agents or sessions on one machine in one call, the voicehook-agent CLI (pro tool) feeds the live activity log, status and decisions of all local sessions into the call automatically; MCP and bridge run on the server and cannot see the user's local sessions. Hard rule: after create_call, show share_text to your user as text first, then call join at once and repeat it until it returns `session` (or start a background job that joins over the HTTPS bridge and wakes you); never end your turn before that. Then keep calling next in a loop.
| Argument | Type | Description |
|---|---|---|
| name | any | Old name of `label` (still accepted). |
Leave the call (optionally speaking `say` first, e.g. a short goodbye). The session handle is invalid afterwards.
| Argument | Type | Description |
|---|---|---|
| say | any | Optional goodbye, max 4000 chars. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "leaveArguments",
"required": [
"session"
],
"properties": {
"say": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Say",
"default": null,
"description": "Optional goodbye, max 4000 chars."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}Wait (up to `timeout` seconds, max 50) for the next event in the call and return it. Event `type`: user (`text` = what the person said; after a pause also `missed` = earlier turns, oldest first, and `away_s`), revise (queued says were replaced; reason user_stop = the person said stop; reason stale + stale:true = your says waited over 60 s unspoken and were dropped (items = seq + text): do not repeat them, if still relevant say ONE short current summary), status_request (the person asked what the agent is doing), decision (answer to a decide question: id, number, verdict yes|no|option|other, option, text, by), helper_decision (the human answered a helper session's question: from, label, id, number, question, verdict, option, text, by; a routing hint, never speak or answer it: send it to that session so it continues), question_check (a status or activity line of this agent reads like a question to the person: id, quote, wait_s, text; answered by decide with the question, or by decide with no_question = id; without either, after wait_s the server puts it on the Decision Board itself, marked as detected automatically, answered only by a human), timeout (nothing happened; reconnect true = server restart), human_left / human_rejoined (the person dropped out / is back; greeted true = the join greeting was just spoken), voicebot_left / voicebot_back (the voicebot dropped out, e.g. a server update; a new one usually joins within ~20 s, says are not heard until then / it is back after `seconds`, say works again), operator (another agent addressed this one: addressed_to_you), data (another agent sent data with send_data: from, kind, payload or url + file_id; never spoken), context (the call language changed, new context), superseded (a newer next call replaced this one), ended (the call is over; detail live_budget, wallet_empty, free_limit or review_budget = budget used up (quota), unspoken says were dropped). Every answer has `humans_present`; user events and `operators_said` lines carry addressed_to / addressed_to_you; a user event with routed_by_delta = the person gave Delta a request, it is yours; a user event with to_kind helper = the person addressed a helper session by name (to), the sentence is in that helper's inbox, info_only; to_kind helper_ambiguous = several helpers matched, Delta asks which one. `agent_said` = what the voicebot said on its own since the last next, `operators_said` = what other agents said (with name), `board_now` / `activity_now` = the agent's current doing line and last feed line as the voicebot sees them, `stale_error` = board or feed older than 60 s while the agent is working, or no activity line yet after the join. Errors: 404 = unknown session (after leave); 5xx, 503 or a network error leave the session valid. Hard rule: after create_call, show share_text to your user as text first, then call join at once and repeat it until it returns `session` (or start a background job that joins over the HTTPS bridge and wakes you); never end your turn before that. Then keep calling next in a loop.
Reach the human who owns this call when they are not on the call page: an SMS to their own confirmed number with a single-use link back into this call (valid 10 min, opens only logged in or with the PIN from the SMS); if they do not open it within 2 minutes, a phone call follows. Prefer this over call_me. Their account rules decide (opt-in, reasons, quiet hours, per day, budget, credit); a refusal returns {status: refused, why}. Otherwise {status: sms_sent|sms_failed|insufficient, phone_call_id, billed_eur, link_valid_s, fallback_call_in_s}. reason: done | blocked | decision. message: max 120 characters, in the SMS.
| Argument | Type | Description |
|---|---|---|
| reason* | string | Why: done, blocked or decision. |
| message | any | Optional short text for the SMS, max 120 chars. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "notify_meArguments",
"required": [
"session",
"reason"
],
"properties": {
"reason": {
"enum": [
"done",
"blocked",
"decision"
],
"type": "string",
"title": "Reason",
"description": "Why: done, blocked or decision."
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message",
"default": null,
"description": "Optional short text for the SMS, max 120 chars."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}The voicebot speaks `text` aloud in the call (verbatim in normal mode; in a live room the voice rephrases it and the answer has verbatim false, mode live_paraphrase). mode: append (default, queued after earlier says), overwrite (replaces this agent's says that have not started yet), revise (like overwrite, and next then returns a revise event). Returns ok and seq.
| Argument | Type | Description |
|---|---|---|
| mode | string | |
| text* | string | What to say, max 4000 chars. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "sayArguments",
"required": [
"session",
"text"
],
"properties": {
"mode": {
"enum": [
"append",
"overwrite",
"revise"
],
"type": "string",
"title": "Mode",
"default": "append"
},
"text": {
"type": "string",
"title": "Text",
"description": "What to say, max 4000 chars."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}Send JSON, text or a file to other agents in this call (silent data channel: never spoken, never shown to the human, never to the voicebot; the human only sees one activity line 'Data to B: name (size)'). to: the other agent's label (as on its chip), its identity, or "*" for all other agents; unknown -> 404 with the labels in the call. kind json: payload any JSON; text: payload a string; file: payload = base64 of the file plus name and mime, or file_id of a file uploaded with the REST endpoint POST /api/bridge/upload (files over about 11 KB, up to 10 MB). The whole packet is max 15000 bytes inline (413 otherwise; base64 makes a file 4/3 larger). Receivers get it in next as type data {from, from_identity, kind, id, name?, mime?, payload | url + file_id, size?}; url is a path, served at https://voicehook.ai<url> with the header Authorization: Bearer <session>. Returns id, to (labels), size.
| Argument | Type | Description |
|---|---|---|
| id | any | Optional own message id (1-64 of [A-Za-z0-9._-]); else the server makes one. |
| to* | string | Label or identity of the receiver, or "*" for all other agents. |
| kind* | string | |
| mime | any | Optional media type, e.g. application/json. |
| name | any | Optional name, e.g. result.json. |
| file_id | any | kind file: id from POST /api/bridge/upload. |
| payload |
Put a card on the person's call page (never spoken): text, code, a link or an image. kind: text (default), code (monospace with copy button), link (exactly one http(s) URL, shown as a tappable link), image (`image` = SVG text or base64 PNG/JPEG/WebP, line breaks, a data:image/...;base64, prefix and missing padding are accepted; or `file_id` of an image uploaded with the REST endpoint POST /api/bridge/upload, which keeps large base64 out of the tool call). A new card appears as a small preview top left; panel cards opens the cards view, board, log or decisions open those panels, none closes them. large: true opens the cards view big in the middle with this card at full size (diagrams, swimlanes; implies panel cards). SVG may draw anything (no scripts, no foreignObject, no external references). Files (reports, tables): kind pdf (preview with page turning and download), csv (table preview of the first rows and download) or md (Markdown, rendered safely, and download) with `data` = the file as base64 and `name` = file name (e.g. report.pdf), or `file_id` from POST /api/bridge/upload. Limits: text 4000 chars, title 80, SVG 300 KB, raster 1024 KB, pdf 10 MB, csv and md 2 MB (UTF-8).
| Argument | Type | Description |
|---|---|---|
| data | any | kind pdf, csv or md: the file as base64 (pdf max 10 MB, csv/md max 2 MB UTF-8). |
| kind | any | |
| name | any | kind pdf, csv or md: file name shown on the card and used for the download. |
| text | any | Card text, max 4000 chars (code: the code; link: the URL). |
| image | any | kind image: SVG text or base64 PNG/JPEG/WebP (SVG max 300 KB, raster max 1 MB). |
Replace the agent's status board on the call page with this one (never spoken; the voicebot answers the person's questions about progress from it). Progress only: questions for the person belong on the Decision Board (decide). doing: current step and ETA (max 400 chars). open / done: max 10 items each, 200 chars per item. faq: up to 6 question/answer pairs the voicebot can answer directly. meta: Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error). emoji (optional): An emoji shown on the agent's chip in the call, from the listed set. Empty string removes it, left out keeps it. Whole board max 2000 chars. Returns ok, humans_present and, when context or faq is missing on an entry, warnings.
| Argument | Type | Description |
|---|---|---|
| faq | any | Max 6 pairs [{"q": "question", "a": "short answer"}]. |
| done | any | Done items, max 10. |
| meta | any | Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error). |
| open | any | Open items, max 10. |
| doing | string | Current step + ETA, max 400 chars. |
| emoji | any |
Change the person's call page right away, like their own clicks: cmd window (win log=activity, dec=decisions, board=status board, wrap=transcript, cards; state open, close, min, medium, large, max), cmd layout (preset halves, quarters, thirds, bigmid, bar), cmd move (win + slot l, m, r, b, tl, tr, bl, br, main, side; optional preset), cmd focus (project voicehook, salesengine, kunden, sonstiges or all: only that project's sections stay open in activity, status and decisions). Never spoken. Only when the person asks for it or it clearly helps (e.g. open decisions after asking one).
| Argument | Type | Description |
|---|---|---|
| cmd* | string | |
| win | any | |
| slot | any | |
| state | any | |
| preset | any | |
| project | any | |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "uiArguments",
"required": [
"session",
"cmd"
],
"properties": {
"cmd": {
"enum": [
"window",
"layout",
"move",
"focus"
],
"type": "string",
"title": "Cmd"
},
"win": {
"anyOf": [
{
"enum": [
"log",
"dec",
"board",
"wrap",
"cards",
"ring"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Win",
"default": null
},
"slot": {
"anyOf": [
{
"enum": [
"l",
"m",
"r",
"b",
"tl",
"tr",
"bl",
"br",
"main",
"side"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Slot",
"default": null
},
"state": {
"anyOf": [
{
"enum": [
"open",
"close",
"min",
"medium",
"large",
"max"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "State",
"default": null
},
"preset": {
"anyOf": [
{
"enum": [
"halves",
"quarters",
"thirds",
"bigmid",
"bar"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Preset",
"default": null
},
"project": {
"anyOf": [
{
"enum": [
"voicehook",
"salesengine",
"kunden",
"sonstiges",
"all"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Project",
"default": null
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}{
"type": "object",
"title": "create_callArguments",
"properties": {
"lang": {
"enum": [
"de",
"en"
],
"type": "string",
"title": "Lang",
"default": "de",
"description": "Language of the person you are calling (default de)."
},
"mode": {
"type": "string",
"const": "normal",
"title": "Mode",
"default": "normal"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "Optional label for your own reference (not shown in the call; your name in the call comes from join)."
},
"solo": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Solo",
"default": null,
"description": "true or left out (default) = solo call: the voicebot speaks as each joining agent, every agent in its own voice and in first person; more agents may join (e.g. a second model next to you). false = the voicebot speaks as itself and announces the agents."
}
}
}| true = remove the decision `id`. |
| context | any | Background (max 1500 chars) the person opens with the arrow next to the question; Delta explains from it. Only reader-relevant, one line per part: Was / Warum / Bei Ja / Bei Nein. |
| options | any | Optional: 2 to 3 answer options, max 40 characters each; leave out for a yes/no question. |
| session* | string | The `session` value returned by join. |
| question | any | The question, max 160 chars (required when creating). |
| recommend | any | Index (0-based) of your recommended option. |
| no_question | any | Id of a question_check event: confirms the line was no question to the person (pass it alone). |
{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
}
},
"title": "decideArguments",
"required": [
"session"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"default": null,
"description": "Id of an open decision to change or delete."
},
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. Without context and 3 faq the result carries `warnings`."
},
"delete": {
"type": "boolean",
"title": "Delete",
"default": false,
"description": "true = remove the decision `id`."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Background (max 1500 chars) the person opens with the arrow next to the question; Delta explains from it. Only reader-relevant, one line per part: Was / Warum / Bei Ja / Bei Nein."
},
"options": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Options",
"default": null,
"description": "Optional: 2 to 3 answer options, max 40 characters each; leave out for a yes/no question."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
},
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Question",
"default": null,
"description": "The question, max 160 chars (required when creating)."
},
"recommend": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Recommend",
"default": null,
"description": "Index (0-based) of your recommended option."
},
"no_question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "No Question",
"default": null,
"description": "Id of a question_check event: confirms the line was no question to the person (pass it alone)."
}
}
}| recommend |
| any |
| Index (0-based) of the recommended option. |
| credential* | string | Helper credential `token` from helper_credential or POST /api/helper/credential. |
| helper_name* | string | Name of this helper session, 1-40 chars (shown on the call page as `from`). |
| no_question | any | Id of a question_check event from helper_next: confirms the line was no question to the person (pass it alone). |
{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
}
},
"title": "helper_decideArguments",
"required": [
"credential",
"helper_name"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"default": null,
"description": "Id of an own open decision to change or delete."
},
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot. Without context and 3 faq the result carries `warnings`."
},
"delete": {
"type": "boolean",
"title": "Delete",
"default": false,
"description": "true = remove the decision `id`."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Background (max 1500 chars) the person opens with the arrow next to the question; Delta explains from it. Only reader-relevant, one line per part: Was / Warum / Bei Ja / Bei Nein."
},
"options": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Options",
"default": null,
"description": "Optional: 2 to 3 answer options, max 40 characters each."
},
"question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Question",
"default": null,
"description": "The question, max 160 chars (required when creating)."
},
"recommend": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Recommend",
"default": null,
"description": "Index (0-based) of the recommended option."
},
"credential": {
"type": "string",
"title": "Credential",
"description": "Helper credential `token` from helper_credential or POST /api/helper/credential."
},
"helper_name": {
"type": "string",
"title": "Helper Name",
"description": "Name of this helper session, 1-40 chars (shown on the call page as `from`)."
},
"no_question": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "No Question",
"default": null,
"description": "Id of a question_check event from helper_next: confirms the line was no question to the person (pass it alone)."
}
}
}| string |
| Name of this helper session, 1-40 chars (shown on the call page as `from`). |
{
"type": "object",
"title": "helper_showArguments",
"required": [
"credential",
"helper_name"
],
"properties": {
"data": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data",
"default": null,
"description": "kind pdf, csv or md: the file as base64."
},
"kind": {
"anyOf": [
{
"enum": [
"text",
"code",
"link",
"image",
"pdf",
"csv",
"md"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Kind",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "kind pdf, csv or md: file name."
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text",
"default": null,
"description": "Card text, max 4000 chars (code: the code; link: the URL)."
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image",
"default": null,
"description": "kind image: SVG text or base64 PNG/JPEG/WebP (SVG max 300 KB, raster max 1 MB)."
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null,
"description": "Optional title, max 80 chars."
},
"credential": {
"type": "string",
"title": "Credential",
"description": "Helper credential `token` from helper_credential or POST /api/helper/credential."
},
"helper_name": {
"type": "string",
"title": "Helper Name",
"description": "Name of this helper session, 1-40 chars (shown on the call page as `from`)."
}
}
}{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
},
"ItemMeta": {
"type": "object",
"title": "ItemMeta",
"properties": {
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Background of this entry for the voicebot (what, why, current state), max 2000 chars."
}
}
},
"BoardMeta": {
"type": "object",
"title": "BoardMeta",
"properties": {
"done": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/ItemMeta"
}
},
{
"type": "null"
}
],
"title": "Done",
"default": null,
"description": "Background per done item, same order as `done`."
},
"open": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/ItemMeta"
}
},
{
"type": "null"
}
],
"title": "Open",
"default": null,
"description": "Background per open item, same order as `open`."
},
"doing": {
"anyOf": [
{
"$ref": "#/$defs/ItemMeta"
},
{
"type": "null"
}
],
"default": null,
"description": "Background of `doing`."
}
}
}
},
"title": "helper_statusArguments",
"required": [
"credential",
"helper_name"
],
"properties": {
"done": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Done",
"default": null,
"description": "Done items, max 10."
},
"meta": {
"anyOf": [
{
"$ref": "#/$defs/BoardMeta"
},
{
"type": "null"
}
],
"default": null,
"description": "Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error)."
},
"open": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Open",
"default": null,
"description": "Open items, max 10."
},
"doing": {
"type": "string",
"title": "Doing",
"default": "",
"description": "Current step + ETA, max 400 chars."
},
"credential": {
"type": "string",
"title": "Credential",
"description": "Helper credential `token` from helper_credential or POST /api/helper/credential."
},
"helper_name": {
"type": "string",
"title": "Helper Name",
"description": "Name of this helper session, 1-40 chars (shown on the call page as `from`)."
}
}
}| greet |
| boolean |
| true (default) = the voicebot greets for you right after the join, in the call language: 'Hallo, hier ist <label>. Worum geht es?' / 'Hi, this is <label>. What can I do for you?'. |
| label | any | Text on your chip in the call, max 22 characters: your session or chat name, else your model name. Too long is rejected. |
| model | string | Exact model id you run on (internal, not shown). |
| quiet | boolean | Accepted for compatibility with the HTTPS bridge; no effect here. |
| voice | any | Optional Chirp3-HD voice for the agent in normal mode, short name (e.g. Puck) or full name; invalid values are ignored. In a one-agent call the voicebot speaks in this voice. |
| invite_url* | string | Invite link https://voicehook.ai/r/<room>?invite=... (max 2048 chars) |
| data_channel | boolean | false (default): every user turn addressed to you wakes your `next`. true = join as a pure DATA CHANNEL: `next` wakes only on a turn addressed to you by name/mention or routed to you by Delta, and on your own decisions; broad turns (to everyone, or a passive followup) stay readable as context (since_last on the next woken event) but do not wake you. |
| status_every | any | Optional seconds between the voicebot's own status summaries of your board, activity and decisions (default 60; 0 = only when the person asks; 10..59 or whole minutes up to 3600). The person can change it in the call. |
{
"type": "object",
"title": "joinArguments",
"required": [
"invite_url"
],
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "Old name of `label` (still accepted)."
},
"greet": {
"type": "boolean",
"title": "Greet",
"default": true,
"description": "true (default) = the voicebot greets for you right after the join, in the call language: 'Hallo, hier ist <label>. Worum geht es?' / 'Hi, this is <label>. What can I do for you?'."
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label",
"default": null,
"description": "Text on your chip in the call, max 22 characters: your session or chat name, else your model name. Too long is rejected."
},
"model": {
"type": "string",
"title": "Model",
"default": "unbekannt",
"description": "Exact model id you run on (internal, not shown)."
},
"quiet": {
"type": "boolean",
"title": "Quiet",
"default": false,
"description": "Accepted for compatibility with the HTTPS bridge; no effect here."
},
"voice": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
],
"title": "Voice",
"default": null,
"description": "Optional Chirp3-HD voice for the agent in normal mode, short name (e.g. Puck) or full name; invalid values are ignored. In a one-agent call the voicebot speaks in this voice."
},
"invite_url": {
"type": "string",
"title": "Invite Url",
"description": "Invite link https://voicehook.ai/r/<room>?invite=... (max 2048 chars)"
},
"data_channel": {
"type": "boolean",
"title": "Data Channel",
"default": false,
"description": "false (default): every user turn addressed to you wakes your `next`. true = join as a pure DATA CHANNEL: `next` wakes only on a turn addressed to you by name/mention or routed to you by Delta, and on your own decisions; broad turns (to everyone, or a passive followup) stay readable as context (since_last on the next woken event) but do not wake you."
},
"status_every": {
"anyOf": [
{
"type": "integer",
"maximum": 3600,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Status Every",
"default": null,
"description": "Optional seconds between the voicebot's own status summaries of your board, activity and decisions (default 60; 0 = only when the person asks; 10..59 or whole minutes up to 3600). The person can change it in the call."
}
}
}| Argument | Type | Description |
|---|---|---|
| session* | string | The `session` value returned by join. |
| timeout | number | Seconds to wait, max 50. |
{
"type": "object",
"title": "next_Arguments",
"required": [
"session"
],
"properties": {
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
},
"timeout": {
"type": "number",
"title": "Timeout",
"default": 45,
"maximum": 50,
"minimum": 0,
"description": "Seconds to wait, max 50."
}
}
}| any |
| json: any JSON value; text: a string; file: base64 of the file. Leave out with file_id. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "send_dataArguments",
"required": [
"session",
"to",
"kind"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"default": null,
"description": "Optional own message id (1-64 of [A-Za-z0-9._-]); else the server makes one."
},
"to": {
"type": "string",
"title": "To",
"description": "Label or identity of the receiver, or \"*\" for all other agents."
},
"kind": {
"enum": [
"json",
"text",
"file"
],
"type": "string",
"title": "Kind"
},
"mime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mime",
"default": null,
"description": "Optional media type, e.g. application/json."
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "Optional name, e.g. result.json."
},
"file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Id",
"default": null,
"description": "kind file: id from POST /api/bridge/upload."
},
"payload": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Payload",
"default": null,
"description": "json: any JSON value; text: a string; file: base64 of the file. Leave out with file_id."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}| large |
| any |
| Open the cards view big in the middle with this card at full size. |
| panel | any |
| title | any | Optional title, max 80 chars. |
| file_id | any | kind image, pdf, csv or md: id from POST /api/bridge/upload (same call, same limits and checks); instead of image or data. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"title": "showArguments",
"required": [
"session"
],
"properties": {
"data": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Data",
"default": null,
"description": "kind pdf, csv or md: the file as base64 (pdf max 10 MB, csv/md max 2 MB UTF-8)."
},
"kind": {
"anyOf": [
{
"enum": [
"text",
"code",
"link",
"image",
"pdf",
"csv",
"md"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Kind",
"default": null
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "kind pdf, csv or md: file name shown on the card and used for the download."
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text",
"default": null,
"description": "Card text, max 4000 chars (code: the code; link: the URL)."
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Image",
"default": null,
"description": "kind image: SVG text or base64 PNG/JPEG/WebP (SVG max 300 KB, raster max 1 MB)."
},
"large": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Large",
"default": null,
"description": "Open the cards view big in the middle with this card at full size."
},
"panel": {
"anyOf": [
{
"enum": [
"board",
"log",
"cards",
"decisions",
"none"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Panel",
"default": null
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": null,
"description": "Optional title, max 80 chars."
},
"file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File Id",
"default": null,
"description": "kind image, pdf, csv or md: id from POST /api/bridge/upload (same call, same limits and checks); instead of image or data."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}| An emoji shown on the agent's chip in the call, from the listed set. "" removes it. |
| session* | string | The `session` value returned by join. |
{
"type": "object",
"$defs": {
"FaqPair": {
"type": "object",
"title": "FaqPair",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"title": "A",
"description": "The prepared answer, max 200 chars."
},
"q": {
"type": "string",
"title": "Q",
"description": "A likely follow-up question of the person, max 200 chars."
}
}
},
"ItemMeta": {
"type": "object",
"title": "ItemMeta",
"properties": {
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/FaqPair"
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Up to 3 likely follow-up questions with prepared answers."
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Context",
"default": null,
"description": "Background of this entry for the voicebot (what, why, current state), max 2000 chars."
}
}
},
"BoardMeta": {
"type": "object",
"title": "BoardMeta",
"properties": {
"done": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/ItemMeta"
}
},
{
"type": "null"
}
],
"title": "Done",
"default": null,
"description": "Background per done item, same order as `done`."
},
"open": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/ItemMeta"
}
},
{
"type": "null"
}
],
"title": "Open",
"default": null,
"description": "Background per open item, same order as `open`."
},
"doing": {
"anyOf": [
{
"$ref": "#/$defs/ItemMeta"
},
{
"type": "null"
}
],
"default": null,
"description": "Background of `doing`."
}
}
}
},
"title": "statusArguments",
"required": [
"session"
],
"properties": {
"faq": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
{
"type": "null"
}
],
"title": "Faq",
"default": null,
"description": "Max 6 pairs [{\"q\": \"question\", \"a\": \"short answer\"}]."
},
"done": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Done",
"default": null,
"description": "Done items, max 10."
},
"meta": {
"anyOf": [
{
"$ref": "#/$defs/BoardMeta"
},
{
"type": "null"
}
],
"default": null,
"description": "Per entry hidden background for the voicebot, never shown on the page: context (max 2000 chars) and faq (up to 3 follow-up questions with prepared answers). Without context and 3 faq on an entry the result carries `warnings` (no error)."
},
"open": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Open",
"default": null,
"description": "Open items, max 10."
},
"doing": {
"type": "string",
"title": "Doing",
"default": "",
"description": "Current step + ETA, max 400 chars."
},
"emoji": {
"enum": [
"",
"😀",
"😃",
"😄",
"😁",
"😆",
"😅",
"🤣",
"😂",
"🙂",
"🙃",
"😉",
"😊",
"😇",
"🥰",
"😍",
"🤩",
"😜",
"🤪",
"🤗",
"🤭",
"🤫",
"🤔",
"🤐",
"🤨",
"😐",
"😶",
"😏",
"😒",
"🙄",
"😬",
"😌",
"😔",
"😴",
"😵",
"🤯",
"🤠",
"🥳",
"😎",
"🤓",
"🧐",
"😕",
"😟",
"🙁",
"😮",
"😯",
"😲",
"😳",
"🥺",
"😨",
"😰",
"😥",
"😢",
"😭",
"😱",
"😞",
"😩",
"😫",
"🥱",
"😤",
"😠",
"😡",
"🤬",
"😈",
"🤖",
"🙈",
"👍",
"👎",
"👌",
"✌️",
"🤞",
"🤟",
"🤙",
"👈",
"👉",
"👆",
"👇",
"☝️",
"👋",
"✋",
"👏",
"🙌",
"🤲",
"🙏",
"💪",
"🫡",
"🫶",
"🤝",
"✍️",
"👀",
"🧠",
"🤷",
"🤦",
"🧘",
"🏃",
"❤️",
"💙",
"💚",
"💛",
"💜",
"🖤",
"💔",
"💯",
"💥",
"💫",
"💤",
"💬",
"💭",
"✨",
"⭐",
"🔥",
"⚡",
"🌈",
"✅",
"❌",
"❓",
"❗",
"⚠️",
"🚧",
"🚫",
"⏳",
"⏰",
"🔄",
"🔨",
"🛠️",
"🔧",
"⚙️",
"🔍",
"🔒",
"🔑",
"📌",
"📝",
"📋",
"📊",
"📈",
"📦",
"🔔",
"💡",
"🎯",
"🚀",
"🏁",
"🎉",
"🏆",
"🧪",
"🧩",
"🐛",
"💻",
"🎧",
"☕",
"🌙",
"☀️"
],
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Emoji",
"default": null,
"description": "An emoji shown on the agent's chip in the call, from the listed set. \"\" removes it."
},
"session": {
"type": "string",
"title": "Session",
"description": "The `session` value returned by join."
}
}
}