Cheapest AI virtual assistant for your business line: $1.99/mo per number, then pay only for usage.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Optional. 'Bearer rk_...' business API key. Without it, only ringkit_create_business works, and it returns a new key.
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.
Close a setup-assistant conversation (conversationId); what it saved stays saved. Reuse an idempotencyKey when retrying; without one, each call executes again.
The conversation's id (from start_setup_chat).
Defaults to the business of the API key in the Authorization header.
Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Pick your client. Values in capitals, like YOUR_TOKEN, are yours to fill in.
Run in a terminal
claude mcp add --transport http ringkit https://api.ringkit.com/mcp
Headers
Authorization (optional, not in the config above): Optional. 'Bearer rk_...' business API key. Without it, only ringkit_create_business works, and it returns a new key.Close a setup-assistant conversation (conversationId); what it saved stays saved. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| conversationId* | string | The conversation's id (from start_setup_chat). |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"conversationId"
],
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"conversationId": {
"type": "string",
"pattern": "^schat_[0-9a-z]{8,32}$",
"description": "The conversation's id (from start_setup_chat)."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 12: Hand it to the owner. Mark first-run setup finished (the business has a number, or the owner chose to do it later) so the dashboard stops nudging. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 8: Place a test call. Confirm a number with the 6-digit code its verification call read (only the person who answered has it). 5 attempts per code. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| code* | string | |
| number* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number",
"code"
],
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{6}$"
},
"number": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 11: Manage API keys. Create an API key: scope manage (acts as owner) or read (read-only tools / GET only). The plaintext apiKey is in this result once and never again. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| scope | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"default": "API key",
"maxLength": 60,
"minLength": 1
},
"scope": {
"enum": [
"manage",
"read"
],
"type": "string",
"default": "manage"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 1: Create the business. Create a RingKit business (pay-per-minute AI phone receptionist) and its first API key, returned once. No auth needed: this is how an agent starts. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| notify | array | |
| website | string | |
| timezone* | string | |
| vertical | string | |
| ownerEmail* | string | |
| ownerPhone | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"timezone",
"ownerEmail"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"notify": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"to"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"type": {
"type": "string",
"const": "sms"
}
}
},
{
"type": "object",
"required": [
"type",
"to"
],
"properties": {
"to": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"type": {
"type": "string",
"const": "email"
}
}
},
{
"type": "object",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"const": "webhook"
},
"secret": {
"type": "string",
"minLength": 16
}
}
}
]
}
},
"website": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"timezone": {
"type": "string",
"minLength": 1
},
"vertical": {
"type": "string",
"maxLength": 60
},
"ownerEmail": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"ownerPhone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 10: Get told about calls. Subscribe a URL to call.completed / message.taken / balance.low events (HMAC-signed with the returned secret, shown once). Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| events* | array | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"url",
"events"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"enum": [
"call.completed",
"message.taken",
"balance.low"
],
"type": "string"
}
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Delete an uploaded knowledge document (by documentId); the receptionist stops using it on the next call. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| documentId* | string | The document's id (from list_knowledge_documents). |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"documentId"
],
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"documentId": {
"type": "string",
"pattern": "^doc_[0-9a-z]{8,32}$",
"description": "The document's id (from list_knowledge_documents)."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Read the auto-refill settings (enabled, threshold, amount) and whether a card is saved.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 12: Hand it to the owner. Read the business: profile, voice, status, how it was created (createdVia) and whether a human owner has signed in (ownerSignedInAt).
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 9: Watch the calls. One call (callId) with its full transcript.
| Argument | Type | Description |
|---|---|---|
| callId* | string | The call's id (from list_calls or simulate_call). |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"callId"
],
"properties": {
"callId": {
"type": "string",
"pattern": "^call_[0-9a-z]{8,32}$",
"description": "The call's id (from list_calls or simulate_call)."
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Read the knowledge profile the receptionist answers from (services, hours, FAQs, policies).
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Read one uploaded document (documentId) with its extracted sections.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| documentId* | string | The document's id (from list_knowledge_documents). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"documentId"
],
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"documentId": {
"type": "string",
"pattern": "^doc_[0-9a-z]{8,32}$",
"description": "The document's id (from list_knowledge_documents)."
}
}
}Read the knowledge tier (starter | pro), its limits, and how many documents/tokens are used.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 2: Teach it the business. The newest website import and its status (queued, running, done, failed), or null when none was started.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Setup progress: the next step (number | done), whether the business has a number, whether the knowledge profile has the basics, and the latest website import.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 9: Watch the calls. A short-lived URL for a call's recording (callId); 404 when the call has none.
| Argument | Type | Description |
|---|---|---|
| callId* | string | The call's id (from list_calls). |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"callId"
],
"properties": {
"callId": {
"type": "string",
"pattern": "^call_[0-9a-z]{8,32}$",
"description": "The call's id (from list_calls)."
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 4: Decide who answers. Read the routing policy: when the AI answers, transfers or takes a message, the schedules, transfer targets and spend cap.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}The open setup-assistant conversation with its messages, or null.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Read which voice stack answers the AI tier: livekit or elevenlabs (the ElevenLabs Agents platform running the same receptionist brain; a caller who needs a person is still transferred to the business's team number or a message is taken). The server chooses the initial stack based on provider availability. Shows desired vs applied, status ok | pending | error, the steps of the last switch and lastError.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 6: Fund the wallet. Read the prepaid wallet balance (cents), including the unspent free trial credit (trialCreditCents, calls only), and auto-refill.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 2: Teach it the business. Crawl the business website now and draft a knowledge profile (hours, services, FAQs...). Set apply=true to save it, or review and use put/patch. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| apply | boolean | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"apply": {
"type": "boolean",
"default": false
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 12: Hand it to the owner. Optional hand-over: emails a sign-in link bound to this business to `email` (default: ownerEmail), adding them as owner first. Nothing in setup needs it: the agent can keep running the line, and the human can take over any time by clicking the link (that sets ownerSignedInAt). 5 per business per hour; pass a new idempotencyKey to send again. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| string | ||
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 11: Manage API keys. List the business's API keys (prefix, scope, last use, revoked or not); never the plaintext.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 12: Hand it to the owner. List the people who can sign in to the business dashboard, with their roles and last sign-in.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 9: Watch the calls. List recent calls with outcome, intent, summary and cost, newest first (paginated).
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| cursor | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"default": 25,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Numbers the business proved it controls (allowed test-call targets and ownerPhone).
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}List uploaded knowledge documents (newest first) with usage against the tier's limits.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Wallet ledger entries (top-ups, call charges, rentals), newest first, paginated.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| cursor | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 7: Get a phone number. List the business's phone numbers.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 3: Pick a voice. List the receptionist voices (id, gender, accent) and the default. Pick one with ringkit_update_business {voice}.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Step 10: Get told about calls. List the business's webhook endpoints and their events.
| Argument | Type | Description |
|---|---|---|
| businessId | string | Defaults to the business of the API key in the Authorization header. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
}
}
}Step 2: Teach it the business. Update some top-level fields of the knowledge profile (others are kept). Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| faqs | array | |
| vibe | object | |
| any | ||
| hours | any | |
| phone | any | |
| staff | array | |
| address | any | |
| summary | string | |
| tagline | any | |
| doNotSay | array | |
| evidence | object | |
| greeting | string | |
| policies | array | |
| services | array | |
| documents | array | |
| bookingUrl | any | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| voiceNotes | string | |
| credentials | any | |
| estimateUrl | any | |
| serviceArea | any | |
| businessName | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
| escalationContacts | array |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"faqs": {
"type": "array",
"items": {
"type": "object",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"maxLength": 1000
},
"q": {
"type": "string"
}
}
}
},
"vibe": {
"type": "object",
"required": [
"tones",
"formality",
"energy",
"audience",
"evidence"
],
"properties": {
"tones": {
"type": "array",
"items": {
"enum": [
"warm",
"professional",
"upbeat",
"calm",
"luxury",
"clinical",
"friendly",
"authoritative"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1
},
"energy": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"audience": {
"type": "string",
"maxLength": 60
},
"evidence": {
"type": "string",
"maxLength": 120
},
"formality": {
"enum": [
"casual",
"neutral",
"formal"
],
"type": "string"
}
}
},
"email": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
]
},
"hours": {
"anyOf": [
{
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 300
},
"regular": {
"type": "object",
"default": {},
"propertyNames": {
"enum": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"open",
"close"
],
"properties": {
"open": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"close": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
}
}
}
},
"exceptions": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"windows"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"note": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"type": "object",
"required": [
"open",
"close"
],
"properties": {
"open": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"close": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
}
}
}
}
},
"default": []
}
}
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
{
"type": "null"
}
]
},
"staff": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"bio": {
"type": "string",
"maxLength": 500
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"schedule": {
"type": "string",
"maxLength": 200
}
}
}
},
"address": {
"anyOf": [
{
"type": "object",
"required": [
"line1",
"city",
"region",
"postalCode"
],
"properties": {
"city": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"region": {
"type": "string"
},
"country": {
"type": "string",
"default": "US"
},
"parking": {
"type": "string",
"maxLength": 300
},
"directions": {
"type": "string",
"maxLength": 500
},
"postalCode": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"summary": {
"type": "string",
"maxLength": 1500
},
"tagline": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"doNotSay": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"evidence": {
"type": "object",
"propertyNames": {
"enum": [
"businessName",
"tagline",
"summary",
"hours",
"address",
"phone",
"email",
"serviceArea",
"credentials",
"estimateUrl",
"bookingUrl",
"services",
"staff",
"faqs",
"policies"
],
"type": "string"
},
"additionalProperties": {
"type": "object",
"required": [
"status"
],
"properties": {
"quote": {
"type": "string",
"maxLength": 1200
},
"status": {
"enum": [
"found",
"inferred",
"owner"
],
"type": "string"
},
"sourceUrl": {
"type": "string",
"pattern": "^https?:\\/\\/"
}
}
}
},
"greeting": {
"type": "string",
"maxLength": 300
},
"policies": {
"type": "array",
"items": {
"type": "object",
"required": [
"topic",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 1000
},
"topic": {
"type": "string"
}
}
}
},
"services": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"priceUsd": {
"type": "number",
"minimum": 0
},
"priceNote": {
"type": "string",
"maxLength": 120
},
"bookingUrl": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string",
"maxLength": 500
},
"durationMin": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}
},
"documents": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"text"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string",
"maxLength": 50000
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"required": [
"kind",
"documentId",
"fileName",
"label",
"uploadedAt"
],
"properties": {
"kind": {
"type": "string",
"const": "upload"
},
"label": {
"type": "string"
},
"fileName": {
"type": "string"
},
"documentId": {
"type": "string",
"pattern": "^doc_[0-9a-z]{8,32}$"
},
"uploadedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
}
},
"sourceUrl": {
"type": "string",
"format": "uri"
}
}
}
},
"bookingUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"voiceNotes": {
"type": "string",
"maxLength": 1000
},
"credentials": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
{
"type": "null"
}
]
},
"estimateUrl": {
"anyOf": [
{
"type": "string",
"pattern": "^https?:\\/\\/"
},
{
"type": "null"
}
]
},
"serviceArea": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "null"
}
]
},
"businessName": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
},
"escalationContacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"when"
],
"properties": {
"when": {
"type": "string",
"maxLength": 300
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"label": {
"type": "string"
},
"phone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
}
}
}
}
}
}Step 7: Get a phone number. Order a phone number for the business ($1.99 a month, billed daily from the wallet). Needs $2 of paid credit available (free trial credit covers calls only); no human sign-in. On 402 funding_required call ringkit_top_up, ask the human to pay the checkoutUrl, then retry. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| number* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 6: Fund the wallet. Turn auto-refill on or off and set its threshold and amount. It may be enabled before a card is saved; refills start once the human saves one in the dashboard. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| enabled* | boolean | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| amountCents* | integer | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
| thresholdCents* | integer |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"enabled",
"thresholdCents",
"amountCents"
],
"properties": {
"enabled": {
"type": "boolean"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"amountCents": {
"type": "integer",
"maximum": 100000,
"minimum": 1000
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
},
"thresholdCents": {
"type": "integer",
"maximum": 100000,
"minimum": 0
}
}
}Step 2: Teach it the business. Replace the whole knowledge profile the AI receptionist answers from. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| faqs | array | |
| vibe | object | |
| string | ||
| hours | object | |
| phone | string | |
| staff | array | |
| address | object | |
| summary | string | |
| tagline | string | |
| doNotSay | array | |
| evidence | object | |
| greeting | string | |
| policies | array | |
| services | array | |
| documents | array | |
| bookingUrl | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| voiceNotes | string | |
| credentials | array | |
| estimateUrl | string | |
| serviceArea | string | |
| businessName | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
| escalationContacts | array |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"faqs": {
"type": "array",
"items": {
"type": "object",
"required": [
"q",
"a"
],
"properties": {
"a": {
"type": "string",
"maxLength": 1000
},
"q": {
"type": "string"
}
}
},
"default": []
},
"vibe": {
"type": "object",
"required": [
"tones",
"formality",
"energy",
"audience",
"evidence"
],
"properties": {
"tones": {
"type": "array",
"items": {
"enum": [
"warm",
"professional",
"upbeat",
"calm",
"luxury",
"clinical",
"friendly",
"authoritative"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1
},
"energy": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"audience": {
"type": "string",
"maxLength": 60
},
"evidence": {
"type": "string",
"maxLength": 120
},
"formality": {
"enum": [
"casual",
"neutral",
"formal"
],
"type": "string"
}
}
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"hours": {
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 300
},
"regular": {
"type": "object",
"default": {},
"propertyNames": {
"enum": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"type": "string"
},
"additionalProperties": {
"type": "array",
"items": {
"type": "object",
"required": [
"open",
"close"
],
"properties": {
"open": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"close": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
}
}
}
},
"exceptions": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"windows"
],
"properties": {
"date": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"note": {
"type": "string"
},
"windows": {
"type": "array",
"items": {
"type": "object",
"required": [
"open",
"close"
],
"properties": {
"open": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"close": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
}
}
}
}
}
},
"default": []
}
}
},
"phone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"staff": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"bio": {
"type": "string",
"maxLength": 500
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"schedule": {
"type": "string",
"maxLength": 200
}
}
},
"default": []
},
"address": {
"type": "object",
"required": [
"line1",
"city",
"region",
"postalCode"
],
"properties": {
"city": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"region": {
"type": "string"
},
"country": {
"type": "string",
"default": "US"
},
"parking": {
"type": "string",
"maxLength": 300
},
"directions": {
"type": "string",
"maxLength": 500
},
"postalCode": {
"type": "string"
}
}
},
"summary": {
"type": "string",
"default": "",
"maxLength": 1500
},
"tagline": {
"type": "string",
"maxLength": 200
},
"doNotSay": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300
},
"default": []
},
"evidence": {
"type": "object",
"propertyNames": {
"enum": [
"businessName",
"tagline",
"summary",
"hours",
"address",
"phone",
"email",
"serviceArea",
"credentials",
"estimateUrl",
"bookingUrl",
"services",
"staff",
"faqs",
"policies"
],
"type": "string"
},
"additionalProperties": {
"type": "object",
"required": [
"status"
],
"properties": {
"quote": {
"type": "string",
"maxLength": 1200
},
"status": {
"enum": [
"found",
"inferred",
"owner"
],
"type": "string"
},
"sourceUrl": {
"type": "string",
"pattern": "^https?:\\/\\/"
}
}
}
},
"greeting": {
"type": "string",
"maxLength": 300
},
"policies": {
"type": "array",
"items": {
"type": "object",
"required": [
"topic",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 1000
},
"topic": {
"type": "string"
}
}
},
"default": []
},
"services": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"priceUsd": {
"type": "number",
"minimum": 0
},
"priceNote": {
"type": "string",
"maxLength": 120
},
"bookingUrl": {
"type": "string",
"format": "uri"
},
"description": {
"type": "string",
"maxLength": 500
},
"durationMin": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
},
"default": []
},
"documents": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"text"
],
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string",
"maxLength": 50000
},
"title": {
"type": "string"
},
"source": {
"type": "object",
"required": [
"kind",
"documentId",
"fileName",
"label",
"uploadedAt"
],
"properties": {
"kind": {
"type": "string",
"const": "upload"
},
"label": {
"type": "string"
},
"fileName": {
"type": "string"
},
"documentId": {
"type": "string",
"pattern": "^doc_[0-9a-z]{8,32}$"
},
"uploadedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
}
}
},
"sourceUrl": {
"type": "string",
"format": "uri"
}
}
},
"default": []
},
"bookingUrl": {
"type": "string",
"format": "uri"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"voiceNotes": {
"type": "string",
"maxLength": 1000
},
"credentials": {
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"estimateUrl": {
"type": "string",
"pattern": "^https?:\\/\\/"
},
"serviceArea": {
"type": "string",
"maxLength": 1000
},
"businessName": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
},
"escalationContacts": {
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"when"
],
"properties": {
"when": {
"type": "string",
"maxLength": 300
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"label": {
"type": "string"
},
"phone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
}
}
},
"default": []
}
}
}Step 4: Decide who answers. Set the routing policy: transfer targets (your own team numbers the receptionist can transfer to) and handoff preferences, recording, spend cap. Full replace; omitted fields take defaults. Every call is answered by the AI (mode ai_only): ai_first/human_first are accepted but RingKit's live-rep pool is not offered, so they act as ai_only. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| mode | string | |
| handoff | object | |
| schedule | array | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| discloseAi | boolean | |
| escalateOn | array | |
| recordCalls | boolean | |
| afterHoursMode | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
| maxHumanOffers | integer | |
| transferTargets | array | |
| dailySpendCapUsd | number | |
| vettedAgentsOnly | boolean | |
| humanRingTimeoutS | integer | |
| neverHumanIntents | array | |
| alwaysHumanIntents | array | |
| requiredAgentSkills | array |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"mode": {
"enum": [
"ai_only",
"ai_first",
"human_first"
],
"type": "string"
},
"handoff": {
"type": "object",
"required": [
"unsure",
"requested",
"urgent"
],
"properties": {
"unsure": {
"enum": [
"message",
"transfer"
],
"type": "string"
},
"urgent": {
"enum": [
"message",
"transfer"
],
"type": "string"
},
"targetId": {
"type": "string"
},
"requested": {
"enum": [
"message",
"transfer"
],
"type": "string"
}
}
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"required": [
"days",
"from",
"to",
"mode"
],
"properties": {
"to": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"days": {
"type": "array",
"items": {
"enum": [
"mon",
"tue",
"wed",
"thu",
"fri",
"sat",
"sun"
],
"type": "string"
},
"minItems": 1
},
"from": {
"type": "string",
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$"
},
"mode": {
"enum": [
"ai_only",
"ai_first",
"human_first"
],
"type": "string"
}
}
}
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"discloseAi": {
"type": "boolean"
},
"escalateOn": {
"type": "array",
"items": {
"enum": [
"caller_requests_human",
"always_human_intent",
"low_confidence",
"repeated_failure"
],
"type": "string"
}
},
"recordCalls": {
"type": "boolean"
},
"afterHoursMode": {
"enum": [
"ai_only",
"ai_first",
"human_first"
],
"type": "string"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
},
"maxHumanOffers": {
"type": "integer",
"maximum": 5,
"minimum": 1
},
"transferTargets": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"number"
],
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"number": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"whenToUse": {
"type": "string",
"maxLength": 300
}
}
}
},
"dailySpendCapUsd": {
"type": "number",
"exclusiveMinimum": 0
},
"vettedAgentsOnly": {
"type": "boolean"
},
"humanRingTimeoutS": {
"type": "integer",
"maximum": 30,
"minimum": 3
},
"neverHumanIntents": {
"type": "array",
"items": {
"type": "string"
}
},
"alwaysHumanIntents": {
"type": "array",
"items": {
"type": "string"
}
},
"requiredAgentSkills": {
"type": "array",
"items": {
"type": "string"
}
}
}
}Switch the voice stack: {stack: livekit | elevenlabs}. Applied synchronously (ElevenLabs agent sync, number import or removal, carrier routing), so it can take a few seconds. Needs an active number and ai_only/ai_first routing (human_first answers 409 voice_stack_unsupported_mode). A failed step answers 502 voice_stack_failed with the status in details: call it again with the same stack to resume. Owner only. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| stack* | string | |
| brainMode | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"stack"
],
"properties": {
"stack": {
"enum": [
"livekit",
"elevenlabs"
],
"type": "string"
},
"brainMode": {
"enum": [
"elevenlabs",
"gateway"
],
"type": "string"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Release a phone number (numberId from list_numbers); it stops taking calls and its rental stops. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| numberId* | string | The number's id (from list_numbers). |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"numberId"
],
"properties": {
"numberId": {
"type": "string",
"pattern": "^num_[0-9a-z]{8,32}$",
"description": "The number's id (from list_numbers)."
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 11: Manage API keys. Revoke an API key (keyId from list_api_keys); it stops authenticating at once, including on this connection if it is this key. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| keyId* | string | The key's id (from list_api_keys). |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"keyId"
],
"properties": {
"keyId": {
"type": "string",
"pattern": "^key_[0-9a-z]{8,32}$",
"description": "The key's id (from list_api_keys)."
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 7: Get a phone number. Search available phone numbers (US, by area code).
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| country | string | |
| areaCode | string | |
| contains | string |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"default": 5,
"maximum": 20,
"minimum": 1
},
"country": {
"type": "string",
"default": "US"
},
"areaCode": {
"type": "string",
"pattern": "^\\d{3}$"
},
"contains": {
"type": "string"
}
}
}Step 2: Teach it the business. Send the owner's message to the setup assistant (conversationId from ringkit_start_setup_chat). The reply lists what was saved in `writes`. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| text* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| conversationId* | string | The conversation's id (from start_setup_chat). |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"text",
"conversationId"
],
"properties": {
"text": {
"type": "string",
"maxLength": 8000,
"minLength": 1
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"conversationId": {
"type": "string",
"pattern": "^schat_[0-9a-z]{8,32}$",
"description": "The conversation's id (from start_setup_chat)."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Switch the knowledge tier. pro: 100 documents / 500k tokens for $5.00/month, accrued daily from the wallet (needs $5 of paid credit available; free trial credit doesn't count); starter: free, 5 documents / 50k tokens (refused while usage is over those limits). Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| tier* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"tier"
],
"properties": {
"tier": {
"enum": [
"starter",
"pro"
],
"type": "string"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 5: Try it in text. Try the receptionist in text mode (no number needed; billed like a call at the AI rate from the wallet, the free trial credit covers it). First call: omit callId and pass callerText "" to get the greeting; then pass the returned callId with each caller line. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| from | string | |
| callId | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| callerText* | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"callerText"
],
"properties": {
"from": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"callId": {
"type": "string",
"pattern": "^call_[0-9a-z]{8,32}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"callerText": {
"type": "string",
"maxLength": 1000
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 2: Teach it the business. Import the business website into the knowledge profile in the background: returns the queued import; poll ringkit_get_latest_knowledge_import until done or failed. Only fields that are still empty are filled; uploaded documents are never touched. An unfinished import is returned instead of starting another. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 2: Teach it the business. Open the setup assistant: a chat that interviews the owner and saves the answers (hours, services, policies, transfers...) into the knowledge profile and routing. Returns the open conversation with the assistant's opening message (restart=true starts over). Capped per business per day. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| context | string | |
| restart | boolean | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"context": {
"enum": [
"onboarding",
"knowledge"
],
"type": "string",
"default": "onboarding"
},
"restart": {
"type": "boolean",
"default": false
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 8: Place a test call. Ring `to` from the business's RingKit number with the AI receptionist (a real call, billed at the AI rate). `to` must be configured on the business (ownerPhone, a transfer target or an SMS notify target) and verified. Ask the human to answer and talk to it like a caller. A retried identical call returns the same result; pass a new idempotencyKey to ring again. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| to* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"to"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 6: Fund the wallet. Add funds (min $10). Returns a checkoutUrl that the human must open and pay (you can't pay), or null when credited immediately (dev). A retried identical call returns the same checkout URL; pass a new idempotencyKey to start a second top-up of the same amount. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| returnTo | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| amountCents* | integer | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"amountCents"
],
"properties": {
"returnTo": {
"enum": [
"wallet",
"onboard"
],
"type": "string",
"default": "wallet"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"amountCents": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1000
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 3: Pick a voice. Update the business: name, timezone, vertical, website, or `voice` (the receptionist's voice, an id from list_voices). Owner identity (ownerEmail, ownerPhone), status and notify need an owner; API keys are owners. Reuse an idempotencyKey when retrying; without one, each call executes again.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| voice | string | |
| notify | array | |
| status | string | |
| website | string | |
| timezone | string | |
| vertical | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| ownerEmail | string | |
| ownerPhone | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"voice": {
"enum": [
"Ashley",
"Olivia",
"Sarah",
"Elizabeth",
"Edward",
"Dennis",
"Mark",
"Theodore",
"el:hpp4J3VqNfWAUOO0d1Us",
"el:EXAVITQu4vr4xnSDxMaL",
"el:XrExE9yKIg1WjnnlVkGX",
"el:cgSgspJ2msm6clMCkdW9",
"el:Xb7hH8MSUJpSbSDYk0k2",
"el:pFZP5JQG7iQjIQuC4Bku",
"el:cjVigY5qzO86Huf0OWal",
"el:iP95p4xoKVk53GoZ742B",
"el:nPczCjzI2devNBz1zQrb",
"el:bIHbv24MWmeRgasZH58o",
"el:JBFqnCBsd6RMkjVDRZzb",
"el:onwK4e9ZLuTAKqWW03F9"
],
"type": "string"
},
"notify": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"required": [
"type",
"to"
],
"properties": {
"to": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"type": {
"type": "string",
"const": "sms"
}
}
},
{
"type": "object",
"required": [
"type",
"to"
],
"properties": {
"to": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"type": {
"type": "string",
"const": "email"
}
}
},
{
"type": "object",
"required": [
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"type": {
"type": "string",
"const": "webhook"
},
"secret": {
"type": "string",
"minLength": 16
}
}
}
]
}
},
"status": {
"enum": [
"active",
"paused",
"suspended"
],
"type": "string"
},
"website": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"timezone": {
"type": "string",
"minLength": 1
},
"vertical": {
"type": "string",
"maxLength": 60
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"ownerEmail": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"ownerPhone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 2: Teach it the business. Upload a document the receptionist should answer from (menu, price list, policies, manual). contentBase64 is the file's bytes, base64-encoded; fileName's extension picks the type: .pdf, .docx, .txt, .md, .html (PDF/DOCX only where the server has them enabled). Text is extracted at upload and searched on every call; a website import never removes uploads. Limits by tier (see get_knowledge_usage): 10 MB per file; Starter 5 documents / 50k tokens, Pro 100 / 500k. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| fileName* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| contentType | string | |
| contentBase64* | string | |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"fileName",
"contentBase64"
],
"properties": {
"fileName": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"contentType": {
"type": "string",
"maxLength": 120
},
"contentBase64": {
"type": "string",
"maxLength": 13981020,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 8: Place a test call. Call `number` from the business's RingKit number and read a 6-digit code twice (valid 10 minutes), to prove the business controls it. The human who answers must tell you the code for ringkit_confirm_destination. A retried identical call returns the same result; pass a new idempotencyKey to place another verification call. Identical requests are deduplicated for 24 hours; use a new idempotencyKey only to deliberately repeat the action.
| Argument | Type | Description |
|---|---|---|
| number* | string | |
| businessId | string | Defaults to the business of the API key in the Authorization header. |
| idempotencyKey | string | Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$"
},
"businessId": {
"type": "string",
"pattern": "^biz_[0-9a-z]{8,32}$",
"description": "Defaults to the business of the API key in the Authorization header."
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Optional. Retries of the same call should reuse it (the stored result comes back); a new value deliberately repeats an identical call. The MCP POST's Idempotency-Key header takes precedence."
}
}
}Step 1: Create the business. The business behind the API key on this connection, with authKind, role and the key's scope (manage or read).
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}We read every tool's name, description and inputs the way the model will, looking for instructions hidden from you. A clean result means no warning signs, not a guarantee. Scanned Nov 6, 2026.
Takes a password, API key or token as an argument, so the secret passes through the model's context and chat logs.
Fix: Read credentials from the server's own configuration (environment, OAuth) instead of a tool argument.