Server definition
- Hash
- sha256:630c0b72f8686384078214ee5bdd6dcbb8373632a010c433afb3ea8a86b4dc65
- What it is
- What a remote MCP server returned when asked what it offers: 206 tools
The blob, as servednamed by its sha256
{
"instructions": "KaiCalls lets Kai phone a business for the person and report back what they said. It can also give them a business line that answers their calls. The first call to a US or Canada business line is free. A call needs only the phone number and what to ask; make_call places it. A call the person asked for before connecting can be placed now. Results come back through check_call_status. To set up or manage a line, start with get_setup_checklist or the next_step from get_business_info.",
"tools": [
{
"description": "Add a teammate's (or the owner's) cell to the phones that ring before Kai answers. Idempotent — a cell already listed is reported as already included. Owners and admins are also registered on the admin roster, so calling the business line from that cell reaches the admin secretary; a member only rings. The business's own forwarded-from office line is refused (forwarding_loop) because ringing it would bounce the call straight back. Requires the phone system to be set up first (set_up_phone_system).",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access multiple businesses).",
"type": "string"
},
"name": {
"description": "Display name for this teammate (optional).",
"type": "string"
},
"phone_number": {
"description": "The cell to add, US format (e.g. (908) 555-1234 or +19085551234).",
"type": "string"
},
"role": {
"description": "member only rings; owner and admin also get admin-secretary access from this cell. Defaults to admin.",
"enum": [
"owner",
"admin",
"member"
],
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "add_team_phone",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"code": {
"description": "Present when success is false.",
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"member": {
"properties": {
"admin_roster": {
"enum": [
"registered",
"skipped_member_role",
"failed"
],
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"phone_number": {
"type": "string"
},
"ring_group": {
"enum": [
"added",
"already_member"
],
"type": "string"
},
"role": {
"type": "string"
}
},
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Accepts published wholesale terms for the agency and applies their discount. Requires the agency owner, and the terms must be in effect and apply to this agency. It charges nothing and doesn't set up payment.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"termsId": {
"description": "The published terms to accept.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"termsId"
],
"type": "object"
},
"name": "agency_billing_accept_terms",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Calculates and locks the wholesale statement for one closed calendar month (UTC) from the agency's billable client intervals. Requires the agency owner. Freezing the same month again returns the same period; it does not charge.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"end": {
"description": "First instant of the following UTC month (ISO date-time).",
"format": "date-time",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"start": {
"description": "First instant of the closed UTC month (ISO date-time).",
"format": "date-time",
"type": "string"
}
},
"required": [
"partnerId",
"start",
"end"
],
"type": "object"
},
"name": "agency_billing_freeze_period",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Publishes a new set of wholesale commercial terms (discount, grace days, document and start date) for one agency, or for all agencies when partnerId is null. Platform commercial operators only. Each call publishes another version; agencies must still accept it.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"discountBps": {
"description": "Wholesale discount in basis points (100 = 1%).",
"maximum": 9900,
"minimum": 0,
"type": "integer"
},
"document": {
"description": "The full terms text.",
"maxLength": 20000,
"minLength": 20,
"type": "string"
},
"effectiveFrom": {
"description": "When the terms take effect (ISO date-time).",
"format": "date-time",
"type": "string"
},
"graceDays": {
"description": "Days allowed for payment before collection is overdue.",
"maximum": 90,
"minimum": 0,
"type": "integer"
},
"partnerId": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "The agency (partner) workspace ID."
},
"title": {
"description": "Name of the terms.",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"partnerId",
"title",
"discountBps",
"graceDays",
"document",
"effectiveFrom"
],
"type": "object"
},
"name": "agency_billing_publish_terms",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Record an already-issued provider credit note or debit invoice against an existing agency billing line. Platform finance operators only: requires the existing admin key and wildcard scope; agency owner status is insufficient. Verifies exact provider receipt, currency and amount before recording bookkeeping. Creates no invoice, payment or subscription.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"amountCents": {
"description": "Correction in cents: negative for a credit, positive for a debit; not zero.",
"maximum": 100000000,
"minimum": -100000000,
"type": "integer"
},
"lineId": {
"description": "The billing line to correct.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"providerCreditNoteId": {
"description": "Provider credit note ID; required for a credit.",
"maxLength": 200,
"type": "string"
},
"providerDebitInvoiceId": {
"description": "Provider invoice ID; required for a debit.",
"maxLength": 200,
"type": "string"
},
"reason": {
"description": "Why the correction is made.",
"maxLength": 500,
"minLength": 1,
"type": "string"
}
},
"required": [
"partnerId",
"lineId",
"amountCents",
"reason"
],
"type": "object"
},
"name": "agency_billing_record_adjustment",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Turns monthly automatic collection of wholesale charges on or off under the accepted terms. Requires the agency owner and accepted terms; it cannot be turned off while any client is on an active partner plan. It charges nothing by itself.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"description": "true to authorize automatic monthly collection, false to stop it.",
"type": "boolean"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"accepted"
],
"type": "object"
},
"name": "agency_billing_set_automatic_collection",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Puts a partner-created client on an agency-billed plan, or stops it when plan is null. Requires the agency owner who is also a client admin; starting a plan needs accepted terms and a ready collection method. Stopping parks the client service, which detaches its phone numbers from the voice agent under the existing parking policy.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"businessId": {
"description": "The partner-created client business.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"plan": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"description": "A partner plan key, or null to stop the client plan."
}
},
"required": [
"partnerId",
"businessId",
"plan"
],
"type": "object"
},
"name": "agency_billing_set_plan",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Creates the agency's customer record at the payment provider if needed and returns a hosted link where the owner adds a payment method. Requires the agency owner and accepted terms. It charges nothing, and the method is ready only after the provider confirms it.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"offerId": {
"description": "Optional offer to return to after setup.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId"
],
"type": "object"
},
"name": "agency_billing_setup_collection",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Launches the approved review-request campaign, queuing text messages to the listed customers from the business number. Requires the client owner, the sms:write scope, accepted set to true and the fingerprint from preview_review. A campaign that is already sending can't be launched again.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"description": "Must be true to confirm the owner approves sending.",
"type": "boolean"
},
"campaignId": {
"description": "Optional campaign ID returned by prepare_review, checked for a match.",
"format": "uuid",
"type": "string"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by preview_review.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fromNumber": {
"description": "The business number to send from (E.164).",
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"milestones": {
"description": "The same milestones used in preview_review.",
"items": {
"additionalProperties": false,
"properties": {
"completedAt": {
"format": "date-time",
"type": "string"
},
"evidenceRef": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"leadId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"leadId",
"completedAt",
"evidenceRef"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"minimumDays": {
"description": "The same minimumDays used in preview_review.",
"maximum": 365,
"minimum": 7,
"type": "integer"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"fromNumber",
"milestones",
"minimumDays"
],
"type": "object"
},
"name": "agency_care_launch_review",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Saves the approved review-request texts as a draft campaign and reserves the listed customers. Requires the client owner, the sms:write scope, accepted set to true and the fingerprint from preview_review. It sends nothing; launch_review sends it.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"description": "Must be true to confirm the owner approves the exact texts and recipients.",
"type": "boolean"
},
"campaignId": {
"format": "uuid",
"type": "string"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by preview_review.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fromNumber": {
"description": "The business number to send from (E.164).",
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"milestones": {
"description": "The same milestones used in preview_review.",
"items": {
"additionalProperties": false,
"properties": {
"completedAt": {
"format": "date-time",
"type": "string"
},
"evidenceRef": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"leadId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"leadId",
"completedAt",
"evidenceRef"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"minimumDays": {
"description": "The same minimumDays used in preview_review.",
"maximum": 365,
"minimum": 7,
"type": "integer"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"fromNumber",
"milestones",
"minimumDays"
],
"type": "object"
},
"name": "agency_care_prepare_review",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Shows the exact review-request text, sender number and recipients for customers with a completed service, with a fingerprint for approval. Requires the client owner, the sms:write scope, and an SMS review installation where Kai is confirmed as the review tool. It sends nothing and saves nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"type": "boolean"
},
"campaignId": {
"format": "uuid",
"type": "string"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fromNumber": {
"description": "The business number to send from (E.164).",
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"milestones": {
"description": "One completed-service record per customer: leadId, completedAt and an evidence reference.",
"items": {
"additionalProperties": false,
"properties": {
"completedAt": {
"format": "date-time",
"type": "string"
},
"evidenceRef": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"leadId": {
"format": "uuid",
"type": "string"
}
},
"required": [
"leadId",
"completedAt",
"evidenceRef"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"minimumDays": {
"description": "Minimum days (7-365) since a customer was last asked before they can be asked again.",
"maximum": 365,
"minimum": 7,
"type": "integer"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"fromNumber",
"milestones",
"minimumDays"
],
"type": "object"
},
"name": "agency_care_preview_review",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Chooses which client activity you hear about (qualified leads, a caller texted one of a client's links, a client needing attention) and where those alerts go. With no emails set, alerts go to the agency owners. Requires an agency owner or admin. Changes future alerts only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"emails": {
"description": "Up to 5 emails for the alerts; an empty list sends them to the agency owners.",
"items": {
"maxLength": 254,
"type": "string"
},
"maxItems": 5,
"type": "array"
},
"events": {
"additionalProperties": false,
"description": "On/off switches: qualified_lead, business_link_sent, client_needs_attention.",
"properties": {
"business_link_sent": {
"type": "boolean"
},
"client_needs_attention": {
"type": "boolean"
},
"qualified_lead": {
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"phone": {
"anyOf": [
{
"maxLength": 40,
"type": "string"
},
{
"type": "null"
}
],
"description": "A phone that also gets the alerts by text; null stops the texts."
}
},
"required": [
"partnerId"
],
"type": "object"
},
"name": "agency_clients_set_activity_alerts",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Changes one client's lead alerts: every lead or qualified leads only, whether the client gets KaiCalls product updates, and which emails and phones get the alerts. Requires write access to that client (agency owner/admin, or an operator assigned to it, who is also an admin on the client's account). Recorded in the client's change history. Sends nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alertEmails": {
"anyOf": [
{
"maxLength": 600,
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated emails that get lead alerts; empty or null clears them."
},
"alertPhones": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated phones that get lead alert texts; empty or null clears them."
},
"businessId": {
"description": "The client business to change.",
"format": "uuid",
"type": "string"
},
"kaicallsUpdatesEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "Whether the client gets KaiCalls product and account updates; null for the default."
},
"leadAlerts": {
"description": "'qualified' (only leads scored 70 or more), 'all' (every real lead) or 'default'.",
"enum": [
"all",
"qualified",
"default"
],
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"businessId"
],
"type": "object"
},
"name": "agency_clients_set_client_alerts",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Sets who your clients should contact about their line and one or two sentences on how you work with them. Shown in every client's dashboard. Requires an agency owner or admin. Sends nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"clientRelationshipNote": {
"anyOf": [
{
"maxLength": 600,
"type": "string"
},
{
"type": "null"
}
],
"description": "How you work with your clients, up to 600 characters; null clears it."
},
"clientSupportContact": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"description": "Email or phone your clients should use; null clears it."
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId"
],
"type": "object"
},
"name": "agency_clients_set_client_profile",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records the client owner's approval of the exact offer and intake facts on their enrollment link. Requires the owner who claimed the link, the session's current revision and its fingerprint. It does not enroll; the agency still enrolls the batch.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The session revision you last read.",
"format": "uuid",
"type": "string"
},
"fingerprint": {
"description": "The session's request fingerprint you reviewed.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The owner's enrollment session.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"expectedRevision",
"fingerprint"
],
"type": "object"
},
"name": "agency_enrollment_approve_owner",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Links the signed-in client owner to their enrollment link using its token. The user's verified email must match the owner email on the link. It approves nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The owner's enrollment session from the link.",
"format": "uuid",
"type": "string"
},
"token": {
"description": "The token from the owner link.",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"token"
],
"type": "object"
},
"name": "agency_enrollment_claim_owner",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Creates an enrollment session for 1-50 existing or new clients against a published offer version and returns one owner approval link per new client. Requires an agency owner, admin or operator with access to each existing client, and an idempotency key; a replay returns the session without the links. It sends no email and installs nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"entries": {
"description": "One entry per client: either businessId (existing client) or newClient (name, externalRef, ownerEmail), plus expectedRevision and intake facts.",
"items": {
"additionalProperties": false,
"properties": {
"businessId": {
"format": "uuid",
"type": "string"
},
"expectedRevision": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
]
},
"facts": {
"additionalProperties": false,
"properties": {
"booking": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
}
},
"required": [
"enabled",
"instruction"
],
"type": "object"
},
"discovery": {
"additionalProperties": false,
"properties": {
"locations": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"label": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"languages": {
"items": {
"maxLength": 60,
"minLength": 1,
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"reviewUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"id",
"label",
"serviceArea",
"languages",
"timezone",
"reviewUrl"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"observations": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"observedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerRole": {
"enum": [
"client_owner",
"agency_operator",
"provider"
],
"type": "string"
},
"revision": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"sourceRef": {
"maxLength": 300,
"minLength": 1,
"type": "string"
},
"state": {
"enum": [
"unknown",
"suggestion",
"conflict",
"owner_confirmed"
],
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 3000,
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"items": {
"maxLength": 500,
"type": "string"
},
"maxItems": 30,
"type": "array"
}
]
}
},
"required": [
"field",
"value",
"sourceRef",
"observedAt",
"state",
"revision",
"ownerRole"
],
"type": "object"
},
"maxItems": 150,
"type": "array"
},
"primaryLocationId": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
]
},
"decision": {
"enum": [
"unknown",
"retain",
"integrate",
"coexist",
"replace"
],
"type": "string"
},
"executor": {
"enum": [
"unknown",
"kai",
"existing",
"human"
],
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"purpose": {
"enum": [
"voice",
"recovery",
"reviews",
"email",
"crm",
"booking",
"reporting"
],
"type": "string"
}
},
"required": [
"name",
"purpose",
"decision",
"executor",
"connectionRef"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
}
},
"required": [
"observations",
"locations",
"primaryLocationId",
"tools"
],
"type": "object"
},
"fallback": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"mode": {
"enum": [
"callback",
"transfer"
],
"type": "string"
},
"phone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
}
},
"required": [
"mode",
"instruction"
],
"type": "object"
},
"faqs": {
"items": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"answer"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
},
"intakeCoverage": {
"additionalProperties": false,
"properties": {
"afterHours": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"schedule": {
"items": {
"additionalProperties": false,
"properties": {
"day": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"end": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
},
"start": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
}
},
"required": [
"day",
"start",
"end"
],
"type": "object"
},
"maxItems": 21,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"schedule",
"afterHours"
],
"type": "object"
},
"profile": {
"additionalProperties": false,
"properties": {
"hours": {
"maxLength": 1000,
"type": "string"
},
"instructions": {
"maxLength": 3000,
"type": "string"
},
"reviewUrl": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"type": "string"
},
"services": {
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
},
"website": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
}
},
"required": [
"timezone",
"services",
"serviceArea",
"hours",
"instructions",
"website",
"reviewUrl"
],
"type": "object"
},
"qualification": {
"items": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"instruction"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"reporting": {
"additionalProperties": false,
"properties": {
"recipientUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"recipientUserIds"
],
"type": "object"
},
"routing": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"maxLength": 200,
"type": "string"
},
"destination": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"destinationPhone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"owner_notification",
"crm"
],
"type": "string"
}
},
"required": [
"kind",
"destination",
"instruction"
],
"type": "object"
},
"schemaVersion": {
"const": 1,
"type": "number"
}
},
"required": [
"schemaVersion",
"profile"
],
"type": "object"
},
"newClient": {
"additionalProperties": false,
"properties": {
"externalRef": {
"maxLength": 150,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"ownerEmail": {
"format": "email",
"maxLength": 254,
"type": "string"
}
},
"required": [
"name",
"externalRef",
"ownerEmail"
],
"type": "object"
}
},
"required": [
"expectedRevision",
"facts"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"offerVersionId": {
"description": "The published offer version to enroll clients in.",
"format": "uuid",
"type": "string"
},
"ownerEmail": {
"description": "Optional default owner email.",
"format": "email",
"maxLength": 254,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"offerVersionId",
"entries"
],
"type": "object"
},
"name": "agency_enrollment_create",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Commits the previewed batch: creates new client businesses, records owner approvals and queues package installations for every ready client; installations later configure each client voice agent. Requires an agency owner, admin or operator who created the session, its idempotency key, and the fingerprint and revision from preview. Clients that are not ready are reported with their next step instead of being installed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"approvalIds": {
"description": "The approval IDs returned by preview for existing clients.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 150,
"type": "array"
},
"expectedRevision": {
"description": "The session revision returned by preview.",
"format": "uuid",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by preview.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The enrollment session to commit.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"expectedRevision",
"fingerprint",
"approvalIds"
],
"type": "object"
},
"name": "agency_enrollment_enroll",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Completes a self-service enrollment after the owner has approved the current intake: creates the client business and queues its package installations, which later configure the business's voice agent. Only the owner who started it can finish it. Repeating it returns the recorded result.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The owner's enrollment session.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId"
],
"type": "object"
},
"name": "agency_enrollment_finish_self_service",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Lets the client owner replace the intake facts on their own enrollment link. Requires the owner who claimed the link and the session's current revision. Saving clears any earlier owner approval, so the owner must approve again.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The session revision you last read.",
"format": "uuid",
"type": "string"
},
"facts": {
"additionalProperties": false,
"description": "The full replacement intake facts.",
"properties": {
"booking": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
}
},
"required": [
"enabled",
"instruction"
],
"type": "object"
},
"discovery": {
"additionalProperties": false,
"properties": {
"locations": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"label": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"languages": {
"items": {
"maxLength": 60,
"minLength": 1,
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"reviewUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"id",
"label",
"serviceArea",
"languages",
"timezone",
"reviewUrl"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"observations": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"observedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerRole": {
"enum": [
"client_owner",
"agency_operator",
"provider"
],
"type": "string"
},
"revision": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"sourceRef": {
"maxLength": 300,
"minLength": 1,
"type": "string"
},
"state": {
"enum": [
"unknown",
"suggestion",
"conflict",
"owner_confirmed"
],
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 3000,
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"items": {
"maxLength": 500,
"type": "string"
},
"maxItems": 30,
"type": "array"
}
]
}
},
"required": [
"field",
"value",
"sourceRef",
"observedAt",
"state",
"revision",
"ownerRole"
],
"type": "object"
},
"maxItems": 150,
"type": "array"
},
"primaryLocationId": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
]
},
"decision": {
"enum": [
"unknown",
"retain",
"integrate",
"coexist",
"replace"
],
"type": "string"
},
"executor": {
"enum": [
"unknown",
"kai",
"existing",
"human"
],
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"purpose": {
"enum": [
"voice",
"recovery",
"reviews",
"email",
"crm",
"booking",
"reporting"
],
"type": "string"
}
},
"required": [
"name",
"purpose",
"decision",
"executor",
"connectionRef"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
}
},
"required": [
"observations",
"locations",
"primaryLocationId",
"tools"
],
"type": "object"
},
"fallback": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"mode": {
"enum": [
"callback",
"transfer"
],
"type": "string"
},
"phone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
}
},
"required": [
"mode",
"instruction"
],
"type": "object"
},
"faqs": {
"items": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"answer"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
},
"intakeCoverage": {
"additionalProperties": false,
"properties": {
"afterHours": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"schedule": {
"items": {
"additionalProperties": false,
"properties": {
"day": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"end": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
},
"start": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
}
},
"required": [
"day",
"start",
"end"
],
"type": "object"
},
"maxItems": 21,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"schedule",
"afterHours"
],
"type": "object"
},
"profile": {
"additionalProperties": false,
"properties": {
"hours": {
"maxLength": 1000,
"type": "string"
},
"instructions": {
"maxLength": 3000,
"type": "string"
},
"reviewUrl": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"type": "string"
},
"services": {
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
},
"website": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
}
},
"required": [
"timezone",
"services",
"serviceArea",
"hours",
"instructions",
"website",
"reviewUrl"
],
"type": "object"
},
"qualification": {
"items": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"instruction"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"reporting": {
"additionalProperties": false,
"properties": {
"recipientUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"recipientUserIds"
],
"type": "object"
},
"routing": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"maxLength": 200,
"type": "string"
},
"destination": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"destinationPhone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"owner_notification",
"crm"
],
"type": "string"
}
},
"required": [
"kind",
"destination",
"instruction"
],
"type": "object"
},
"schemaVersion": {
"const": 1,
"type": "number"
}
},
"required": [
"schemaVersion",
"profile"
],
"type": "object"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The owner's enrollment session.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"expectedRevision",
"facts"
],
"type": "object"
},
"name": "agency_enrollment_owner_save",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Checks every client in the batch for missing facts, owner approval and payer conflicts, and returns what enrolling would install, with the fingerprint and approval IDs needed to enroll. Requires an agency owner, admin or operator. It records the preview on the session but installs nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The enrollment session to preview.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId"
],
"type": "object"
},
"name": "agency_enrollment_preview",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Revokes an enrollment session and all of its owner links so nothing more can be approved or enrolled from it. Requires the session creator or an agency owner/admin. Installations that were already enrolled are not removed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The enrollment session to revoke.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId"
],
"type": "object"
},
"name": "agency_enrollment_revoke",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Issues a new owner link for a client in the batch and invalidates the old one, clearing any earlier claim and approval. Requires the session creator (or an agency owner/admin) and the link's current revision. It sends nothing; the returned link is delivered by whoever re-issued it.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The session revision you last read.",
"format": "uuid",
"type": "string"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The owner's enrollment session to re-issue.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_enrollment_rotate_owner_link",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Replaces the client entries of an uncommitted enrollment session. Requires the session creator (or an agency owner/admin) and the current session revision. Saving revokes all outstanding owner approval links for the batch, so owners must be sent new links.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"entries": {
"description": "The full replacement list of client entries.",
"items": {
"additionalProperties": false,
"properties": {
"businessId": {
"format": "uuid",
"type": "string"
},
"expectedRevision": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
]
},
"facts": {
"additionalProperties": false,
"properties": {
"booking": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
}
},
"required": [
"enabled",
"instruction"
],
"type": "object"
},
"discovery": {
"additionalProperties": false,
"properties": {
"locations": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"label": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"languages": {
"items": {
"maxLength": 60,
"minLength": 1,
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"reviewUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"id",
"label",
"serviceArea",
"languages",
"timezone",
"reviewUrl"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"observations": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"observedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerRole": {
"enum": [
"client_owner",
"agency_operator",
"provider"
],
"type": "string"
},
"revision": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"sourceRef": {
"maxLength": 300,
"minLength": 1,
"type": "string"
},
"state": {
"enum": [
"unknown",
"suggestion",
"conflict",
"owner_confirmed"
],
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 3000,
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"items": {
"maxLength": 500,
"type": "string"
},
"maxItems": 30,
"type": "array"
}
]
}
},
"required": [
"field",
"value",
"sourceRef",
"observedAt",
"state",
"revision",
"ownerRole"
],
"type": "object"
},
"maxItems": 150,
"type": "array"
},
"primaryLocationId": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
]
},
"decision": {
"enum": [
"unknown",
"retain",
"integrate",
"coexist",
"replace"
],
"type": "string"
},
"executor": {
"enum": [
"unknown",
"kai",
"existing",
"human"
],
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"purpose": {
"enum": [
"voice",
"recovery",
"reviews",
"email",
"crm",
"booking",
"reporting"
],
"type": "string"
}
},
"required": [
"name",
"purpose",
"decision",
"executor",
"connectionRef"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
}
},
"required": [
"observations",
"locations",
"primaryLocationId",
"tools"
],
"type": "object"
},
"fallback": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"mode": {
"enum": [
"callback",
"transfer"
],
"type": "string"
},
"phone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
}
},
"required": [
"mode",
"instruction"
],
"type": "object"
},
"faqs": {
"items": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"answer"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
},
"intakeCoverage": {
"additionalProperties": false,
"properties": {
"afterHours": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"schedule": {
"items": {
"additionalProperties": false,
"properties": {
"day": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"end": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
},
"start": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
}
},
"required": [
"day",
"start",
"end"
],
"type": "object"
},
"maxItems": 21,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"schedule",
"afterHours"
],
"type": "object"
},
"profile": {
"additionalProperties": false,
"properties": {
"hours": {
"maxLength": 1000,
"type": "string"
},
"instructions": {
"maxLength": 3000,
"type": "string"
},
"reviewUrl": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"type": "string"
},
"services": {
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
},
"website": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
}
},
"required": [
"timezone",
"services",
"serviceArea",
"hours",
"instructions",
"website",
"reviewUrl"
],
"type": "object"
},
"qualification": {
"items": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"instruction"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"reporting": {
"additionalProperties": false,
"properties": {
"recipientUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"recipientUserIds"
],
"type": "object"
},
"routing": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"maxLength": 200,
"type": "string"
},
"destination": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"destinationPhone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"owner_notification",
"crm"
],
"type": "string"
}
},
"required": [
"kind",
"destination",
"instruction"
],
"type": "object"
},
"schemaVersion": {
"const": 1,
"type": "number"
}
},
"required": [
"schemaVersion",
"profile"
],
"type": "object"
},
"newClient": {
"additionalProperties": false,
"properties": {
"externalRef": {
"maxLength": 150,
"minLength": 1,
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"ownerEmail": {
"format": "email",
"maxLength": 254,
"type": "string"
}
},
"required": [
"name",
"externalRef",
"ownerEmail"
],
"type": "object"
}
},
"required": [
"expectedRevision",
"facts"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"expectedRevision": {
"description": "The session revision you last read.",
"format": "uuid",
"type": "string"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The enrollment session.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"sessionId",
"expectedRevision",
"entries"
],
"type": "object"
},
"name": "agency_enrollment_save",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Starts a business owner's own enrollment in a published agency offer, using the business name and intake facts. Requires a signed-in user session with a verified email and an idempotency key; the same key replays the same session. Nothing is installed until the owner approves and finishes.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"facts": {
"additionalProperties": false,
"description": "Intake facts: business profile, hours, qualification questions, routing, fallback, booking, FAQs and reporting.",
"properties": {
"booking": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
}
},
"required": [
"enabled",
"instruction"
],
"type": "object"
},
"discovery": {
"additionalProperties": false,
"properties": {
"locations": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"label": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"languages": {
"items": {
"maxLength": 60,
"minLength": 1,
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"reviewUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"id",
"label",
"serviceArea",
"languages",
"timezone",
"reviewUrl"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"observations": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"observedAt": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
]
},
"ownerRole": {
"enum": [
"client_owner",
"agency_operator",
"provider"
],
"type": "string"
},
"revision": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"sourceRef": {
"maxLength": 300,
"minLength": 1,
"type": "string"
},
"state": {
"enum": [
"unknown",
"suggestion",
"conflict",
"owner_confirmed"
],
"type": "string"
},
"value": {
"anyOf": [
{
"maxLength": 3000,
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"items": {
"maxLength": 500,
"type": "string"
},
"maxItems": 30,
"type": "array"
}
]
}
},
"required": [
"field",
"value",
"sourceRef",
"observedAt",
"state",
"revision",
"ownerRole"
],
"type": "object"
},
"maxItems": 150,
"type": "array"
},
"primaryLocationId": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
]
},
"decision": {
"enum": [
"unknown",
"retain",
"integrate",
"coexist",
"replace"
],
"type": "string"
},
"executor": {
"enum": [
"unknown",
"kai",
"existing",
"human"
],
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"purpose": {
"enum": [
"voice",
"recovery",
"reviews",
"email",
"crm",
"booking",
"reporting"
],
"type": "string"
}
},
"required": [
"name",
"purpose",
"decision",
"executor",
"connectionRef"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
}
},
"required": [
"observations",
"locations",
"primaryLocationId",
"tools"
],
"type": "object"
},
"fallback": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"mode": {
"enum": [
"callback",
"transfer"
],
"type": "string"
},
"phone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
}
},
"required": [
"mode",
"instruction"
],
"type": "object"
},
"faqs": {
"items": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"answer"
],
"type": "object"
},
"maxItems": 30,
"type": "array"
},
"intakeCoverage": {
"additionalProperties": false,
"properties": {
"afterHours": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"schedule": {
"items": {
"additionalProperties": false,
"properties": {
"day": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"end": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
},
"start": {
"pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
"type": "string"
}
},
"required": [
"day",
"start",
"end"
],
"type": "object"
},
"maxItems": 21,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"schedule",
"afterHours"
],
"type": "object"
},
"profile": {
"additionalProperties": false,
"properties": {
"hours": {
"maxLength": 1000,
"type": "string"
},
"instructions": {
"maxLength": 3000,
"type": "string"
},
"reviewUrl": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
},
"serviceArea": {
"maxLength": 500,
"type": "string"
},
"services": {
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
},
"website": {
"anyOf": [
{
"const": "",
"type": "string"
},
{
"format": "uri",
"maxLength": 1000,
"type": "string"
}
]
}
},
"required": [
"timezone",
"services",
"serviceArea",
"hours",
"instructions",
"website",
"reviewUrl"
],
"type": "object"
},
"qualification": {
"items": {
"additionalProperties": false,
"properties": {
"instruction": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"question": {
"maxLength": 300,
"minLength": 1,
"type": "string"
}
},
"required": [
"question",
"instruction"
],
"type": "object"
},
"maxItems": 20,
"type": "array"
},
"reporting": {
"additionalProperties": false,
"properties": {
"recipientUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"timezone": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"timezone",
"recipientUserIds"
],
"type": "object"
},
"routing": {
"additionalProperties": false,
"properties": {
"connectionRef": {
"maxLength": 200,
"type": "string"
},
"destination": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"destinationPhone": {
"pattern": "^\\+[1-9][0-9]{7,14}$",
"type": "string"
},
"instruction": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"kind": {
"enum": [
"owner_notification",
"crm"
],
"type": "string"
}
},
"required": [
"kind",
"destination",
"instruction"
],
"type": "object"
},
"schemaVersion": {
"const": 1,
"type": "number"
}
},
"required": [
"schemaVersion",
"profile"
],
"type": "object"
},
"idempotencyKey": {
"description": "Stable key for this request; reuse it when retrying the same request.",
"maxLength": 150,
"type": "string"
},
"name": {
"description": "The business name.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"offerVersionId": {
"description": "The published offer version to enroll in.",
"format": "uuid",
"type": "string"
}
},
"required": [
"offerVersionId",
"name",
"facts"
],
"type": "object"
},
"name": "agency_enrollment_start_self_service",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Applies an approved update and re-queues setup, which replaces the client's live voice agent configuration. Requires agency write access or the client owner, a resolved update with no open conflicts, fresh owner approval, and (unless this client is the canary) an active canary on the same release. Applying an already-applied update changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint of the approved update.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"updateId": {
"description": "The approved update to apply.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"updateId",
"fingerprint"
],
"type": "object"
},
"name": "agency_installation_apply_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records the client owner approving either the intake facts or the voice script they reviewed. Requires the client owner and the matching hash from owner_preview. It does not install anything by itself.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"businessId": {
"description": "The owner's business.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The agency enrollment session that prepared the preview.",
"format": "uuid",
"type": "string"
},
"subject": {
"description": "What is being approved: facts or script.",
"enum": [
"facts",
"script"
],
"type": "string"
},
"subjectHash": {
"description": "The factsHash or scriptHash returned by owner_preview.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}
},
"required": [
"partnerId",
"businessId",
"sessionId",
"subject",
"subjectHash"
],
"type": "object"
},
"name": "agency_installation_approve",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records the client owner approving the exact staff handoff they reviewed. Requires the client owner and the fingerprint from preview_handoff.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by the matching preview action.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_approve_handoff",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records the client owner acknowledging the route test receipt they reviewed. Requires the client owner who received the notification and the fingerprint from preview_route_receipt. It does not place any call.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by the matching preview action.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_approve_route_receipt",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records the client owner approving the updated script of a proposed update. Requires the client owner, the updateId and its fingerprint. It does not apply the update.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint of the proposed update.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"updateId": {
"description": "The proposed update.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"updateId",
"fingerprint"
],
"type": "object"
},
"name": "agency_installation_approve_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Returns the installation release, intake facts, approved script, staff sheet and checks for handoff or records. Requires client membership or agency assignment to the client. It changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_export",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Starts offboarding: stops the package's jobs, revokes its future automation authority and turns off its scheduled reports. Requires the client owner, accepted set to true and the fingerprint from preview_offboard. The phone number, connections, billing plan and history are kept.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"description": "Must be true to confirm the owner accepts the previewed effects.",
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint returned by the matching preview action.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_offboard",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Marks the client's installation as a canary, so it can receive package updates before other clients of the same agency. Requires the client owner and accepted set to true. It applies no update by itself.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"description": "Must be true to confirm the owner opts in.",
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"accepted"
],
"type": "object"
},
"name": "agency_installation_opt_into_canary",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Shows the client owner the exact intake facts and voice script prepared for their business, with the hashes needed to approve each. Only the client owner can view it, and only after the agency prepared a complete preview. It changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"businessId": {
"description": "The owner's business.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"sessionId": {
"description": "The agency enrollment session that prepared the preview.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"businessId",
"sessionId"
],
"type": "object"
},
"name": "agency_installation_owner_preview",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Pauses an installation so its package setup and scheduled package work stop. Requires agency write access to the client or the client owner, and the current revision. It does not delete anything; use retry to queue it again.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_pause",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Returns the staff handoff for an installation with a fingerprint for approval. Requires client membership or agency assignment to the client. It changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_preview_handoff",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Shows what offboarding would stop and what it keeps (phone number, sender, connections, billing plan and history), with a fingerprint for approval. Only the client owner can view it. It changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_preview_offboard",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Returns the evidence that a real call reached the client's voice line and produced a delivered lead notification, with a fingerprint for acknowledgement. Only for voice intake installations whose training is complete, and only the client owner who received that notification can view it. It changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_preview_route_receipt",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Prepares a proposed update to a newer published offer version, or a rollback to an earlier installation revision, and lists any conflicts with client changes. Requires agency write access to the client or the client owner. It saves the proposal for review but does not apply it; client facts are always kept.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"offerVersionId": {
"description": "Published offer version to update to. Either this or rollbackRevision is required.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"rollbackRevision": {
"description": "Earlier installation revision to roll back to.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_preview_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Chooses, for each conflicting setting in a proposed package update, whether to keep the client's current value or use the package value, and saves the resolved update. Requires the client owner and the update's fingerprint; client facts cannot be overridden this way. It does not apply the update, and the resolved version needs fresh owner approval.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"choices": {
"additionalProperties": {
"enum": [
"keep_client",
"use_package"
],
"type": "string"
},
"description": "For every conflict path listed by preview_update: keep_client or use_package.",
"type": "object"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"description": "The fingerprint of the proposed update.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"updateId": {
"description": "The proposed update returned by preview_update.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"updateId",
"fingerprint",
"choices"
],
"type": "object"
},
"name": "agency_installation_resolve_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Re-queues an installation so setup runs again, clearing its last error; setup configures the client's voice agent. Requires agency write access to the client or the client owner, and the current revision.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"accepted": {
"const": true,
"type": "boolean"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_installation_retry",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Withdraws one of the client owner's earlier approvals. Requires the client owner. Work that depends on that approval waits until it is approved again.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"approvalId": {
"description": "The approval to withdraw.",
"format": "uuid",
"type": "string"
},
"businessId": {
"description": "The owner's business.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"businessId",
"approvalId"
],
"type": "object"
},
"name": "agency_installation_revoke_approval",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Run approved verification scenarios for an existing client installation at its expected revision using voice agent compute under existing entitlement. Requires current assigned client authority, current owner approval and evals:write. Saves test evidence and can incur irreversible usage charges; a new request key can run and charge again. Makes no real customer calls.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"requestId": {
"description": "A stable ID for this run; reuse it to continue the same run.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"requestId"
],
"type": "object"
},
"name": "agency_installation_run_scenarios",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Archives an offer so it can no longer be published or used for new enrollments. Requires an agency owner or admin and the current offer revision. Existing installations are not removed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The offer revision you last read.",
"format": "uuid",
"type": "string"
},
"offerId": {
"description": "The offer to archive.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"offerId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_offer_archive",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Builds the publishable manifest and sales kit for an offer draft and returns its fingerprint and revision for publishing. Requires an agency owner or admin. It saves nothing and fails if a package release, variant or claim is not supported.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"offerId": {
"description": "The offer draft to preview.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"offerId"
],
"type": "object"
},
"name": "agency_offer_preview",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Publishes the previewed offer as a new immutable version and returns its enrollment link. Requires an agency owner or admin, plus the fingerprint and revision from preview; partner-billed offers also need billing collection to be ready. Publishing the same fingerprint again returns the existing version.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The draft revision returned by preview.",
"format": "uuid",
"type": "string"
},
"fingerprint": {
"description": "The manifest fingerprint returned by preview.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"offerId": {
"description": "The offer to publish.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"offerId",
"expectedRevision",
"fingerprint"
],
"type": "object"
},
"name": "agency_offer_publish",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Creates a new offer draft, or replaces an existing draft when offerId and its current revision are given. Requires an agency owner or admin. Saving changes only the draft; clients see nothing until it is published.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"draft": {
"additionalProperties": false,
"description": "The offer: name, industry, commercial mode, retail price and scope, 1-3 packages, supported claims, support policy and the branding-limitations acknowledgement.",
"properties": {
"brandingLimitationsAcknowledged": {
"const": true,
"type": "boolean"
},
"commercialMode": {
"enum": [
"commission",
"partner_billed"
],
"type": "string"
},
"industry": {
"enum": [
"legal",
"home_services",
"neutral"
],
"type": "string"
},
"name": {
"maxLength": 160,
"minLength": 1,
"type": "string"
},
"packages": {
"items": {
"additionalProperties": false,
"properties": {
"key": {
"enum": [
"convert",
"care",
"improve"
],
"type": "string"
},
"variant": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"version": {
"maxLength": 80,
"minLength": 1,
"type": "string"
}
},
"required": [
"key",
"version",
"variant"
],
"type": "object"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
},
"retail": {
"additionalProperties": false,
"properties": {
"collection": {
"const": "agency_external",
"type": "string"
},
"currency": {
"const": "USD",
"type": "string"
},
"monthlyCents": {
"maximum": 100000000,
"minimum": 0,
"type": "integer"
},
"scope": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
}
},
"required": [
"monthlyCents",
"currency",
"scope",
"collection"
],
"type": "object"
},
"supportPolicy": {
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
"supportedClaims": {
"items": {
"enum": [
"approved_intake_setup",
"owner_approved_campaign_drafts",
"recorded_activity_reporting"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"industry",
"commercialMode",
"retail",
"packages",
"supportedClaims",
"supportPolicy",
"brandingLimitationsAcknowledged"
],
"type": "object"
},
"expectedRevision": {
"description": "Current draft revision; required when offerId is given.",
"format": "uuid",
"type": "string"
},
"offerId": {
"description": "Existing offer to update. Without it, a new draft is created.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"draft"
],
"type": "object"
},
"name": "agency_offer_save",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Joins the agency using the token from an invite link. The signed-in user must have a verified email that matches the invited address, and the invite must be unexpired and not revoked. Accepting the same invite again is a no-op.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"token": {
"description": "The token from the invite link.",
"maxLength": 200,
"minLength": 1,
"type": "string"
}
},
"required": [
"partnerId",
"token"
],
"type": "object"
},
"name": "agency_profile_accept_invite",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Gives an active agency staff member access to one client business with the admin or member business role. Requires an agency owner or admin who can manage that client; only the owner can assign an admin staff member. Assigning an existing assignment again changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"businessId": {
"description": "The client business to grant access to.",
"format": "uuid",
"type": "string"
},
"businessRole": {
"description": "Business role to grant: admin or member.",
"enum": [
"admin",
"member"
],
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"userId": {
"description": "The agency staff member to assign.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"userId",
"businessId",
"businessRole"
],
"type": "object"
},
"name": "agency_profile_assign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Registers a new agency for the signed-in user and makes them its owner, using the given brand and support details. Requires a signed-in user session with a verified email; an API key cannot create an agency. Repeating it for an agency that already exists does not create a second one.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"brand": {
"additionalProperties": false,
"description": "Agency brand: name and an optional HTTPS logo URL.",
"properties": {
"logoUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
],
"default": ""
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"support": {
"additionalProperties": false,
"description": "Support contact shown to clients: email, owner name, optional HTTPS help URL and a coverage statement.",
"properties": {
"coverage": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"helpUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
],
"default": ""
},
"ownerName": {
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"required": [
"email",
"ownerName",
"coverage"
],
"type": "object"
}
},
"required": [
"brand",
"support"
],
"type": "object"
},
"name": "agency_profile_bootstrap",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Creates a staff invitation for an email address with the admin, operator or reader role and returns a one-time invite link that expires in 7 days. Requires an agency owner or admin; only the owner can invite an admin. It sends no email; the returned link is delivered by whoever created the invite.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"email": {
"description": "Email address the invitee must sign in with (verified).",
"format": "email",
"maxLength": 254,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"role": {
"description": "Role granted on acceptance: admin, operator or reader.",
"enum": [
"admin",
"operator",
"reader"
],
"type": "string"
}
},
"required": [
"partnerId",
"email",
"role"
],
"type": "object"
},
"name": "agency_profile_invite",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Creates a new API key for yourself in this agency, limited to the requested scopes, and returns the secret once. Readers cannot get write scopes, only the agency owner can get billing:write, and a delegated key cannot issue a key broader than itself. Each call creates another key (up to 20 active per user).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"name": {
"description": "A label for the key.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"scopes": {
"description": "Scopes to grant, from the supported agency set (for example workspaces:read, agents:write, billing:read).",
"items": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"maxItems": 25,
"minItems": 1,
"type": "array"
}
},
"required": [
"partnerId",
"name",
"scopes"
],
"type": "object"
},
"name": "agency_profile_issue_key",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Cancels a pending staff invitation so its link can no longer be used. Requires an agency owner or admin. It does not remove anyone who already accepted; revoke_member does that.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"inviteId": {
"description": "The invitation to cancel.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"inviteId"
],
"type": "object"
},
"name": "agency_profile_revoke_invite",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Removes a staff member from the agency: revokes their membership, all their client assignments, their accepted invites and every API key issued to them through the agency. Requires an agency owner or admin; only the owner can remove an admin, and the owner cannot be removed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"userId": {
"description": "The staff member to remove.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"userId"
],
"type": "object"
},
"name": "agency_profile_revoke_member",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Removes a staff member's agency assignment to one client business, and removes the business membership if this assignment created it. Requires an agency owner or admin; only the owner can unassign an admin. It does not remove the person from the agency.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"businessId": {
"description": "The client business to remove access from.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"userId": {
"description": "The agency staff member to unassign.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"userId",
"businessId"
],
"type": "object"
},
"name": "agency_profile_unassign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Replaces the agency brand, support details and requested commercial mode. Requires an agency owner or admin and the current profile revision; a stale revision is rejected. It does not change any published offer.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"brand": {
"additionalProperties": false,
"properties": {
"logoUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
],
"default": ""
},
"name": {
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"commercialMode": {
"description": "commission (client pays the platform directly) or partner_billed (the agency is billed wholesale).",
"enum": [
"commission",
"partner_billed"
],
"type": "string"
},
"expectedRevision": {
"description": "The profile revision you last read.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"support": {
"additionalProperties": false,
"properties": {
"coverage": {
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"helpUrl": {
"anyOf": [
{
"format": "uri",
"maxLength": 1000,
"type": "string"
},
{
"const": "",
"type": "string"
}
],
"default": ""
},
"ownerName": {
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"required": [
"email",
"ownerName",
"coverage"
],
"type": "object"
}
},
"required": [
"partnerId",
"expectedRevision",
"brand",
"support",
"commercialMode"
],
"type": "object"
},
"name": "agency_profile_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Sets the weekly or monthly activity report email schedule for an installation and replaces the previous recipient list. Requires the client owner; recipients must be verified members of the client's business. The first report is sent by the scheduled job, not by this call.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"cadence": {
"description": "weekly or monthly.",
"enum": [
"weekly",
"monthly"
],
"type": "string"
},
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
},
"recipients": {
"description": "User IDs (1-20) of verified business members who should receive the report.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision",
"recipients",
"cadence"
],
"type": "object"
},
"name": "agency_report_configure",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Generate and save an activity report snapshot for an existing client installation at its expected revision. Requires current client membership and agency access. Queues report email for due owner-approved subscriptions to existing verified client members and advances their schedule; queued does not mean delivered.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"expectedRevision": {
"description": "The installation revision you last read. The call is rejected if the installation has changed since.",
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"installationId": {
"description": "The agency package installation to act on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"expectedRevision"
],
"type": "object"
},
"name": "agency_report_generate",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Marks an agency incident as acknowledged and assigns its follow-up to you. Requires an agency owner, admin or operator. It does not resolve the incident; recovery is confirmed separately.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incidentId": {
"description": "The incident to acknowledge.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"incidentId"
],
"type": "object"
},
"name": "agency_support_acknowledge",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Save completion evidence for a named operational exercise on an existing client installation. Requires current assigned client authority. Replaces any previous proof reference and completion time for that exercise; does not prove live customer delivery.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"exercise": {
"description": "verify_launch, handle_failure, report_activity or export_handoff.",
"enum": [
"verify_launch",
"handle_failure",
"report_activity",
"export_handoff"
],
"type": "string"
},
"installationId": {
"description": "The installation the exercise was done on.",
"format": "uuid",
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"installationId",
"exercise"
],
"type": "object"
},
"name": "agency_support_complete_exercise",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Records time spent or money for one client (setup, support, fulfillment, provider cost or retail receipt) with a note. Requires an agency owner, admin or operator with write access to that client. Each call adds a new record.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"amountCents": {
"description": "Amount in US cents, if measuring money.",
"maximum": 100000000,
"minimum": 0,
"type": "integer"
},
"businessId": {
"description": "The client business the measurement is for.",
"format": "uuid",
"type": "string"
},
"kind": {
"description": "setup, support, fulfillment, provider_cost or retail_receipt.",
"enum": [
"setup",
"support",
"fulfillment",
"provider_cost",
"retail_receipt"
],
"type": "string"
},
"minutes": {
"description": "Minutes spent, if measuring time.",
"maximum": 100000,
"minimum": 0,
"type": "integer"
},
"note": {
"description": "Short description of the work or amount.",
"maxLength": 500,
"minLength": 1,
"type": "string"
},
"partnerId": {
"description": "The agency (partner) workspace ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"partnerId",
"businessId",
"kind",
"note"
],
"type": "object"
},
"name": "agency_support_measure",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"receipt": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send the person's answer to a live call's pending_question, or decline. Send only what they said; answered once.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"answer": {
"description": "The person's answer, in their words (required unless decline is true)",
"type": "string"
},
"call_id": {
"description": "The KaiCalls call ID from make_call",
"type": "string"
},
"decline": {
"description": "True when the person does not want to share this (optional)",
"type": "boolean"
},
"question_id": {
"description": "The pending_question.question_id to answer (optional; defaults to the oldest open question)",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "answer_call_question",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call_id": {
"type": "string"
},
"code": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"question_id": {
"type": [
"string",
"null"
]
},
"replayed": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "The business owner approves one exact revision of a drafted email campaign, named by campaign_id and the fingerprint returned by draft_email_campaign or get_email_campaign. A changed draft has a new fingerprint and needs a new approval. Sends nothing; launch_email_campaign queues it. Business owner only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"campaign_id": {
"description": "The drafted campaign.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of the exact revision the owner reviewed.",
"type": "string"
}
},
"required": [
"business_id",
"campaign_id",
"fingerprint"
],
"type": "object"
},
"name": "approve_email_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Assign a phone number already in the KaiCalls registry pool to a business (and optionally route it directly to an agent). Does NOT purchase a new number; search_available_numbers and buy_number handle purchases.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent ID to route this number to directly (optional).",
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"phone_number": {
"description": "E.164 phone number already in the registry.",
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "attach_number",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"number": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Have a voice agent answer calls on ONE number from the business's own connected Twilio account, calls only. Reads only that number. dry_run defaults to true and changes nothing: it returns would_change (the number's VoiceUrl and VoiceMethod) and the fields left unchanged. With dry_run false, only that number's VoiceUrl and VoiceMethod change; its text settings (SmsUrl, SmsMethod, SmsApplicationSid, StatusCallback) are read back afterwards and must be unchanged, so a texting setup another service runs on the account keeps working. Refuses a number a Twilio app answers, and a number another service answers unless replace_existing_voice is true. Uses one plan line. Requires admin role.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent that should answer the calls.",
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"dry_run": {
"description": "Default true: report what would change and write nothing.",
"type": "boolean"
},
"phone_number": {
"description": "E.164 number on the business's own connected Twilio account.",
"type": "string"
},
"replace_existing_voice": {
"description": "Allow replacing another service that answers calls on this number today.",
"type": "boolean"
}
},
"required": [
"phone_number",
"agent_id"
],
"type": "object"
},
"name": "attach_own_twilio_number",
"outputSchema": {
"additionalProperties": true,
"properties": {
"after": {
"type": "object"
},
"before": {
"type": "object"
},
"business_id": {
"type": "string"
},
"dry_run": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"unchanged": {
"items": {
"type": "string"
},
"type": "array"
},
"would_change": {
"type": "object"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Request a real phone-number purchase. This is APPROVAL-GATED: the carrier bills immediately on execution, so the tool only prepares a request for authenticated owner review. Caller-supplied human_confirmed, dashboard_session, or system_policy fields never authorize execution. Returns the stored request and a review URL for the owner; while approval is pending, no number has been purchased. Existing entitlement and carrier reservation checks still apply. In the acquisition flow this follows set_owner_phone, which saves a reachable owner number or records a decline.",
"inputSchema": {
"properties": {
"actor": {
"description": "Who is asking: { type: agent|human|system|integration, id, display_name }.",
"type": "object"
},
"agent_id": {
"description": "Agent ID to route this number to directly once purchased (optional; requires the number to also be voice-runtime-imported, which is not guaranteed at purchase time — a follow-up attach_number call routes it reliably).",
"type": "string"
},
"authority": {
"description": "Attribution only. human_confirmed and other caller-supplied modes cannot authorize a purchase. Authenticated owner review of the exact stored request is required.",
"type": "object"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"dry_run": {
"description": "Validate tenant, scope, and policy without buying anything.",
"type": "boolean"
},
"idempotency_key": {
"description": "Stable key for the purchase request; repeating it returns the original outcome. Defaults to a key derived from the phone number — a new key retries a previously failed purchase.",
"type": "string"
},
"phone_number": {
"description": "The exact E.164 phone number to purchase, as returned by search_available_numbers.",
"type": "string"
},
"queue_for_approval": {
"description": "Create a durable owner-review request (default true). Setting false returns needs_approval, but an authority-envelope retry still cannot execute.",
"type": "boolean"
},
"reason": {
"description": "Optional reason recorded in the durable audit.",
"type": "string"
},
"source_ref": {
"description": "External source reference, such as a ticket or automation run ID.",
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "buy_number",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"description": "On executed: { number, voice_agent_registered, agent_attached, compliance: { high_risk_category, disclosure_note } }.",
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Stop an email campaign so nothing more is sent from it. Emails already delivered stay delivered. Needs campaign_id and the fingerprint of its current revision. Business owner only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"campaign_id": {
"description": "The campaign to stop.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of its current revision, from get_email_campaign.",
"type": "string"
}
},
"required": [
"business_id",
"campaign_id",
"fingerprint"
],
"type": "object"
},
"name": "cancel_email_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Cancel the business's plan when the owner asks to. The plan stays on until the end of the paid period (or trial) and is never charged again; a past-due plan ends now. Pass undo=true to keep a plan whose cancel has not taken effect yet. Requires the current owner role. Confirm with the owner before calling.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"detail": {
"description": "The owner's own words.",
"maxLength": 500,
"type": "string"
},
"reason": {
"description": "Why the owner is cancelling. Required to cancel (not for undo): ask the owner, and pass other with their words in detail if none fits.",
"enum": [
"customer_service",
"low_quality",
"missing_features",
"other",
"switched_service",
"too_complex",
"too_expensive",
"unused"
],
"type": "string"
},
"undo": {
"description": "true keeps the plan: undoes a cancel that has not taken effect yet.",
"type": "boolean"
}
},
"type": "object"
},
"name": "cancel_subscription",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"manage_url": {
"type": "string"
},
"message": {
"type": "string"
},
"outcome": {
"enum": [
"no_paid_plan",
"canceling",
"canceled_now",
"resumed",
"not_canceling"
],
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Check the status of a call by its ID: while it is live, the latest turns of the conversation (live_transcript) and any question Kai is waiting on (pending_question); after, a voicemail message left, or the business calling back. Also takes the intent_id of a call scheduled for calling hours and says when it goes out",
"inputSchema": {
"properties": {
"call_id": {
"description": "The call ID to check, or the intent_id make_call returned for a scheduled call",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "check_call_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call": {
"properties": {
"agent_id": {
"type": [
"string",
"null"
]
},
"agent_name": {
"type": [
"string",
"null"
]
},
"business_id": {
"type": "string"
},
"conversation_id": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"duration_seconds": {
"type": [
"number",
"null"
]
},
"id": {
"type": "string"
},
"lead_id": {
"type": [
"string",
"null"
]
},
"quality_dimensions": {
"type": [
"object",
"array",
"null"
]
},
"recording_url": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"live_transcript": {
"description": "Latest turns while the call is live, oldest first (up to 30); null once it ends. Use get_transcript for the full call.",
"items": {
"properties": {
"speaker": {
"enum": [
"kai",
"other"
],
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"pending_question": {
"properties": {
"answer_within_seconds": {
"type": "integer"
},
"asked_at": {
"type": "string"
},
"open_questions": {
"type": "integer"
},
"question": {
"type": "string"
},
"question_id": {
"type": "string"
},
"seconds_waiting": {
"type": [
"integer",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Re-check a sending domain's DNS records with the email delivery provider now and replace its saved verification proof; may finish provider inbound routing, inbox and webhook setup. Returns what is still missing; an empty list means the sender is ready. Sends no email. Any member of the business may check.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"sender_id": {
"description": "The sender to re-check, from request_email_sender or get_email_campaign.",
"type": "string"
}
},
"required": [
"business_id",
"sender_id"
],
"type": "object"
},
"name": "check_email_sender",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "APPROVAL-GATED. After private-test proof is complete, save forwarding, published_number, both, or testing. This unlocks the command center but does not claim customer coverage; selected customer routes remain pending until independently verified. Forwarding is optional; testing keeps the existing private-test result without connecting a customer route.",
"inputSchema": {
"properties": {
"activation_session_id": {
"type": "string"
},
"authority": {
"type": "object"
},
"business_id": {
"type": "string"
},
"choice": {
"enum": [
"forwarding",
"published_number",
"both",
"testing"
],
"type": "string"
},
"idempotency_key": {
"type": "string"
},
"source_phone": {
"description": "Existing business number, required for forwarding or both.",
"type": "string"
}
},
"required": [
"business_id",
"activation_session_id",
"choice",
"idempotency_key"
],
"type": "object"
},
"name": "choose_customer_route",
"outputSchema": {
"additionalProperties": true,
"properties": {
"activation_session_id": {
"type": "string"
},
"business_id": {
"type": "string"
},
"command_center_unlocked": {
"type": "boolean"
},
"customer_coverage_active": {
"type": "boolean"
},
"deployment_choice": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"instructions": {
"items": {
"type": "string"
},
"type": "array"
},
"routes": {
"items": {
"type": "object"
},
"type": "array"
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Safely add or replace a named operational rules section inside an agent inbound prompt, then route the prompt patch through the governed agent.patch broker. It covers cross-business handoffs, callback language, alert promises, and client-specific operating rules, and leaves the rest of the prompt unchanged.",
"inputSchema": {
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "KaiCalls agent ID to update",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the agent has multiple accessible assignments.",
"type": "string"
},
"dry_run": {
"description": "Validate and show the prompt patch metadata without writing.",
"type": "boolean"
},
"idempotency_key": {
"description": "Required for writes. A retry with the same key applies the same proposed prompt change only once.",
"type": "string"
},
"mode": {
"description": "replace (default) swaps the named section for these rules; append adds them to it.",
"enum": [
"replace",
"append"
],
"type": "string"
},
"queue_for_approval": {
"description": "When authority is missing, create a pending dashboard approval instead of returning needs_approval.",
"type": "boolean"
},
"rules": {
"description": "Plain-language operational rules to insert as bullets, e.g. callback capture, sister-location boundaries, urgent alert handling.",
"items": {
"type": "string"
},
"type": "array"
},
"section_title": {
"description": "Prompt section heading to replace/append. Default: Operational handoff rules.",
"type": "string"
},
"source_ref": {
"description": "External source reference, such as a support ticket or assistant conversation ID.",
"type": "string"
}
},
"required": [
"agent_id",
"rules"
],
"type": "object"
},
"name": "configure_agent_business_rules",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_id": {
"type": [
"string",
"null"
]
},
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"rules_count": {
"type": [
"integer",
"null"
]
},
"section_title": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Save the business's alert contacts and post-call escalation rules. Read get_operational_settings first: each list you send (notification_phone, notification_email, escalation_rules) replaces the whole saved list, so include the entries to keep. Listed phones get after-call summary texts and escalation texts (one-recipient alerts go to the first phone); listed emails get escalation emails. lead_alerts chooses every lead or qualified leads only, and kaicalls_updates_enabled turns KaiCalls product and setup mail on or off (both default to quiet for a business a partner set up). Saving does not prove delivery.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
},
"dry_run": {
"description": "Validate and show the proposed settings without writing.",
"type": "boolean"
},
"email_notifications": {
"description": "Enable or disable email staff alerts for this business.",
"type": "boolean"
},
"escalation_rules": {
"description": "Post-call escalation rules checked against each finished call. Replaces the saved rules. Each rule is { id?, when, then, enabled? }.",
"items": {
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"then": {
"description": "Action keys. text_owner (the only one) texts and emails every alert contact above, not only the owner.",
"items": {
"type": "string"
},
"type": "array"
},
"when": {
"description": "Natural-language trigger, e.g. \"Caller needs a same-day callback from the recovery room\".",
"type": "string"
}
},
"required": [
"when"
],
"type": "object"
},
"type": "array"
},
"kaicalls_updates_enabled": {
"description": "KaiCalls product news, setup tips, weekly summaries and account nudges to this business. Off by default for a business set up by a partner. Billing receipts and team invitations always go. null = account default.",
"type": [
"boolean",
"null"
]
},
"lead_alert_min_score": {
"description": "Exact lead score bar for alerts (0 = every lead). Overrides lead_alerts. null = account default.",
"maximum": 100,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"lead_alerts": {
"description": "'qualified' = alert only on leads scored 70+ and stop the per-call 'a call came in' texts and emails; 'all' = every real lead; 'default' = the account default (qualified for a business set up by a partner, else all).",
"enum": [
"all",
"qualified",
"default"
],
"type": "string"
},
"notification_email": {
"description": "Email addresses that get escalation emails. Replaces the saved list. Comma-separated string or array.",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"notification_phone": {
"description": "Phones that get alert texts; the first also gets one-recipient alerts. Replaces the saved list. Comma-separated string or array.",
"items": {
"type": "string"
},
"type": [
"string",
"array"
]
},
"sms_notifications": {
"description": "Enable or disable SMS staff alerts for this business.",
"type": "boolean"
}
},
"type": "object"
},
"name": "configure_staff_alerts",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"current_settings": {
"type": [
"object",
"null"
]
},
"dry_run": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"proposed_settings": {
"type": "object"
},
"settings": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create or repair the business_links entries used by the send_link/send_sms tools. These entries let callers receive booking, directions, cancellation, sister-location, or service-specific links by text without raw URLs in the voice prompt.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
},
"dry_run": {
"description": "Validate and show create/update plan without writing.",
"type": "boolean"
},
"links": {
"description": "Links to create/update by link_key. New links require label and destination_url. Existing links can be deactivated with is_active=false.",
"items": {
"properties": {
"destination_url": {
"description": "HTTPS destination URL. kaicalls.com destinations are rejected.",
"type": "string"
},
"is_active": {
"description": "Whether this link can be sent.",
"type": "boolean"
},
"label": {
"description": "Human label for the link.",
"type": "string"
},
"link_key": {
"description": "Snake_case key the agent/tool uses, e.g. recovery_directions.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"links"
],
"type": "object"
},
"name": "configure_textable_links",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"dry_run": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"links": {
"items": {
"type": "object"
},
"type": "array"
},
"plan": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "APPROVAL-GATED. Save the owner-approved phone number (SMS) or email address where KaiCalls sends the owner the result of their first test call, for the exact active activation session. Once that test call's record is ready, KaiCalls sends a real text or email to that destination through its messaging provider; saving the destination alone is not proof anything was delivered. Replaces any destination saved earlier for the session.",
"inputSchema": {
"properties": {
"activation_session_id": {
"type": "string"
},
"authority": {
"type": "object"
},
"business_id": {
"type": "string"
},
"channel": {
"enum": [
"sms",
"email"
],
"type": "string"
},
"destination": {
"type": "string"
},
"idempotency_key": {
"type": "string"
}
},
"required": [
"business_id",
"activation_session_id",
"channel",
"destination",
"idempotency_key"
],
"type": "object"
},
"name": "confirm_notification_destination",
"outputSchema": {
"additionalProperties": true,
"properties": {
"activation_session_id": {
"type": "string"
},
"attempt": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": "string"
},
"delivery_started": {
"type": "boolean"
},
"destination_masked": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Connect an external agent to a business and its signed event outbox. Requires current business admin membership, an assigned Kai agent, and agents:write, sms:write, webhooks:write. New SMS/WhatsApp conversations route to the external agent; explicit handoffs win. Grants no additional permissions and does not activate unregistered channels. Use a stable idempotency_key; replacements require expected_revision. The signing secret is returned only for a non-replayed connect. External realtime voice and email execution are not connected by this operation.",
"inputSchema": {
"properties": {
"a2a_enabled": {
"default": false,
"description": "Route public A2A message/send to the signed receiver, which must return a JSON-RPC A2A message. SDK handleA2ARequest/handle_a2a_request connects the receiver to your own agent.",
"type": "boolean"
},
"a2a_url": {
"description": "Optional existing native A2A endpoint; requires a2a_enabled. Omit to use the signed event receiver.",
"format": "uri",
"maxLength": 2048,
"pattern": "^https://",
"type": [
"string",
"null"
]
},
"agent_id": {
"format": "uuid",
"type": "string"
},
"business_id": {
"format": "uuid",
"type": "string"
},
"expected_revision": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"external_agent_id": {
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/@-]{0,199}$",
"type": "string"
},
"external_reply_timeout_seconds": {
"maximum": 86400,
"minimum": 60,
"type": [
"integer",
"null"
]
},
"idempotency_key": {
"description": "Required in the body or Idempotency-Key header.",
"pattern": "^[!-~]{1,200}$",
"type": "string"
},
"webhook_url": {
"format": "uri",
"maxLength": 2048,
"pattern": "^https://",
"type": "string"
}
},
"required": [
"agent_id",
"external_agent_id",
"webhook_url",
"idempotency_key"
],
"type": "object"
},
"name": "connect_agent",
"outputSchema": null
},
{
"description": "Get the one link a business owner opens to put WhatsApp on their KaiCalls number. They sign in to Facebook as an admin of the business's Meta Business account and verify the number; the business owns its WhatsApp account. Uses the business's oldest KaiCalls line unless phone_number names another of its lines. Returns the same link while it is still valid (up to 3 days). Owner or admin only. Creates nothing billable and connects nothing by itself: get_whatsapp_status reports the connection after the owner finishes, and WhatsApp is not connected until it says so.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"phone_number": {
"description": "E.164, one of the business lines.",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "connect_whatsapp",
"outputSchema": {
"additionalProperties": true,
"properties": {
"created": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"whatsapp": {
"type": "object"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create a new KaiCalls agent — the secretary that answers this business’s calls (the live voice agent plus KaiCalls records) — with a system prompt, greeting, voice, and model. Its starting settings are saved as version 1 and each later change as a new version (list_config_versions); rollback_config restores a version's greeting, voice, prompt, model and summary/scoring. Compliance: KaiCalls automatically applies state-aware AI-disclosure and consent handling to every agent it provisions, and flags high-risk business categories for extra review.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID to create the agent under.",
"type": "string"
},
"first_message": {
"description": "Spoken greeting (optional). Leave it out to use the industry intake greeting, which opens on the caller's need.",
"type": "string"
},
"metadata": {
"description": "Extra KaiCalls metadata to store (optional).",
"type": "object"
},
"model": {
"description": "Language model selection: { provider, model, temperature } (optional).",
"type": "object"
},
"name": {
"description": "Agent display name.",
"type": "string"
},
"system_prompt": {
"description": "The agent's inbound system prompt (optional). Leave it out to start on the business's industry intake script, the same one a signup gets.",
"type": "string"
},
"vertical_pack": {
"description": "Setup pack id (optional; inferred from the business when left out). One of: hvac, plumbing, electrical, general-contractor, garage-door, general-contractors, handyman, landscaping, moving, pest-control, pool-service, cleaning, roofing, personal-injury, family-law, insurance-claims, criminal-defense, eviction-law, legal-family-law, immigration-law, legal-personal-injury, party-rentals, tent-rentals, event-equipment, equipment-rental, restaurant-orders, catering, auto-repair, mobile-mechanic, towing, dive-shop, fitness, wellness-recovery, chiropractic-pt, chiropractic, dental, medical-practice, med-spa, mental-health-therapy, veterinary, photography, salon-barbershop, financial-services, insurance-agency, recruiting-staffing, tax-accounting, property-management, real-estate.",
"type": "string"
},
"voice": {
"description": "Raw voice selection: { provider, voiceId } (optional).",
"type": "object"
},
"voice_catalog_id": {
"description": "Preferred: a curated catalog id from list_voices (optional).",
"type": "string"
}
},
"required": [
"business_id",
"name"
],
"type": "object"
},
"name": "create_agent",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent": {
"type": "object"
},
"compliance": {
"properties": {
"disclosure_note": {
"type": "string"
},
"high_risk_category": {
"type": "boolean"
}
},
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"script": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create an outbound call campaign (cadence + lead batch) and optionally launch it immediately. Launching queues calls for the orchestrator; existing TCPA/consent gating still applies at dial time. Requires admin role on the business.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent ID to place the calls. Required when launch is true.",
"type": "string"
},
"business_id": {
"description": "Business ID (required only when the token can access multiple businesses).",
"type": "string"
},
"cadence_config": {
"description": "Cadence configuration. { template: standard|aggressive|nurture|custom, attempts: number }.",
"properties": {
"attempts": {
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"description": {
"description": "Optional campaign description.",
"type": "string"
},
"launch": {
"description": "When true, launch the campaign immediately after creating it.",
"type": "boolean"
},
"lead_ids": {
"description": "Lead IDs to enroll in the campaign (optional at create time).",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Campaign name.",
"type": "string"
}
},
"required": [
"name",
"cadence_config"
],
"type": "object"
},
"name": "create_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"campaign": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"launched": {
"type": "boolean"
},
"queued": {
"type": [
"integer",
"null"
]
},
"sequence_id": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"total_leads": {
"type": [
"integer",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create, or reuse, a secure payment page hosted by Stripe where the business owner pays for a KaiCalls plan from list_plans with their own card. Needs business_id, plan_id and an idempotency_key: retrying with the same key returns the same page, and choosing a different plan needs a new key. This tool charges nothing; only the owner can pay, by opening the page themselves. It never proves payment or that the phone line is live: get_checkout_status reports payment for the returned session_id.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business the plan is for.",
"type": "string"
},
"idempotency_key": {
"description": "Stable key for this checkout; reuse it when retrying.",
"maxLength": 128,
"minLength": 8,
"type": "string"
},
"plan_id": {
"description": "A plan key from list_plans.",
"type": "string"
}
},
"required": [
"business_id",
"plan_id",
"idempotency_key"
],
"type": "object"
},
"name": "create_checkout",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"session_id": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create a new KaiCalls account for a business, owned by the business owner's own email address. It lets a partner or helper set up KaiCalls for a business owner. The account starts without a plan or phone number: the result includes a link the owner opens themselves to choose a plan and add their card, and the line is set up only after they pay. This tool charges nothing. By default the caller is added as an admin of the new account so they can continue setup (get_setup_checklist lists the steps); join_as_admin false skips that. partner_code credits a referring partner and does not apply to a partner's own account. Fails, creating nothing, if the email already has a KaiCalls account.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_name": {
"type": "string"
},
"business_type": {
"type": "string"
},
"city": {
"type": "string"
},
"join_as_admin": {
"description": "Default true.",
"type": "boolean"
},
"owner_cell": {
"description": "Owner's cell; calls ring it first once the line is live.",
"type": "string"
},
"owner_email": {
"description": "The business owner's own email. They own the workspace.",
"type": "string"
},
"partner_code": {
"description": "Referring partner's code.",
"type": "string"
},
"plan_id": {
"description": "A plan key from list_plans.",
"type": "string"
},
"state": {
"type": "string"
},
"website": {
"type": "string"
}
},
"required": [
"business_name",
"owner_email"
],
"type": "object"
},
"name": "create_customer_workspace",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"checkout_url": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"joined_as_admin": {
"type": "boolean"
},
"owner_email": {
"type": "string"
},
"partner_linked": {
"description": "Present for a partner-scoped key: the new business is linked to the partner.",
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Save a test scenario for one of the business's agents: what a caller says and what the agent's reply must do to pass. run_eval then grades the agent against it. Saving places no call and changes nothing on the agent.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"agent_id": {
"description": "The agent to test.",
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"caller_says": {
"description": "The caller's opening message, e.g. \"I was rear-ended yesterday and need a lawyer.\"",
"type": "string"
},
"description": {
"description": "What the scenario checks (optional).",
"type": "string"
},
"name": {
"description": "Short scenario name, up to 80 characters.",
"type": "string"
},
"pass_if": {
"description": "What the agent's reply must do to pass, in plain words, e.g. \"Asks for the caller's name and number and does not give legal advice.\"",
"type": "string"
}
},
"required": [
"agent_id",
"name",
"caller_says",
"pass_if"
],
"type": "object"
},
"name": "create_eval",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"eval": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Remove a business outbound webhook by ID.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"id": {
"description": "Webhook ID to remove.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_webhook",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"message": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Release a phone number from a business back to the unassigned registry pool.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"phone_number": {
"description": "E.164 phone number to release.",
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "detach_number",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"released_phone_number": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Stop a voice agent answering a number from the business's own connected Twilio account and put back the call setting (VoiceUrl and VoiceMethod) the number had before it was attached. The number is never released from the account and its text settings are not touched. Requires admin role.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"phone_number": {
"description": "E.164 number to stop answering.",
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "detach_own_twilio_number",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"detached": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"restored": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Disconnect the external agent and disable its webhook atomically. Requires current business admin membership and agents:write, sms:write, webhooks:write. Pass the stored expected_revision. Inherited conversations return to Kai; explicit handoffs remain.",
"inputSchema": {
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"expected_revision": {
"minimum": 1,
"type": "integer"
}
},
"required": [
"expected_revision"
],
"type": "object"
},
"name": "disconnect_agent",
"outputSchema": null
},
{
"description": "Save an email campaign for the owner to review: a subject, a plain-text body, the customers to email (lead_ids, each with recorded email permission) and the verified sender. Returns the campaign id and the fingerprint of this exact revision. Sends nothing; the owner approves it with approve_email_campaign and it only goes out after launch_email_campaign. Needs an admin of the business. Campaign email only goes from the business’s own verified sending domain, to customers with recorded email permission who are not on the do-not-email list, within the daily amount the business’s Kai level allows.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"daily_limit": {
"description": "Optional: most emails sent per day (default: the most the sender and the Kai level allow).",
"type": "integer"
},
"design": {
"additionalProperties": false,
"description": "Optional structured email design. text must equal its rendered text version; no raw HTML. The owner approves the exact HTML and text.",
"properties": {
"accentColor": {
"type": "string"
},
"body": {
"type": "string"
},
"businessName": {
"type": "string"
},
"buttonLabel": {
"type": "string"
},
"buttonUrl": {
"type": "string"
},
"headline": {
"type": "string"
},
"preheader": {
"type": "string"
},
"version": {
"enum": [
1
],
"type": "integer"
}
},
"required": [
"version",
"businessName",
"preheader",
"headline",
"body",
"buttonLabel",
"buttonUrl",
"accentColor"
],
"type": "object"
},
"lead_ids": {
"description": "The customers (lead ids) to email; each needs recorded email permission.",
"items": {
"type": "string"
},
"type": "array"
},
"sender_id": {
"description": "The verified sender to send from.",
"type": "string"
},
"subject": {
"description": "The email subject.",
"type": "string"
},
"text": {
"description": "The plain-text email body.",
"type": "string"
}
},
"required": [
"business_id",
"sender_id",
"subject",
"text",
"lead_ids"
],
"type": "object"
},
"name": "draft_email_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Find the three voices that best match a plain description of what the owner wants (for example 'a Southern man who can also speak Spanish' or 'warm older woman, calm'), and get a page link where the owner can play each one in English and Spanish, pick one to switch the agent's voice, and undo within 24 hours. Show the owner the page link; nothing changes until they pick. The link expires in 7 days.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "The agent whose voice the owner wants to change.",
"type": "string"
},
"business_id": {
"description": "Business ID, needed only when the agent belongs to more than one business.",
"type": "string"
},
"description": {
"description": "The owner's own words for the voice: gender, accent or region, age, feel, languages.",
"type": "string"
},
"locale": {
"description": "Optional language hint like \"es\" when the description does not say.",
"type": "string"
}
},
"required": [
"agent_id",
"description"
],
"type": "object"
},
"name": "find_voices",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"expires_at": {
"type": "string"
},
"page_url": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"voices": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read current call readiness and persisted private-test proof for one accessible business. Only a currently entitled owner with a coherent assigned number gets the existing private-test setup link. Missing entitlement, incomplete setup or stale sessions do not authorize a call. It cannot assert or advance proof. A completed private test is separate from customer-route coverage; forwarding is optional and does not define whether the assigned phone works.",
"inputSchema": {
"properties": {
"activation_session_id": {
"description": "Optional exact session ID. A superseded or foreign session is rejected.",
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token reaches exactly one business).",
"type": "string"
},
"oauth_transaction_id": {
"description": "Opaque OAuth transaction identifier used only to bind a completed receipt.",
"type": "string"
},
"origin_conversation_id": {
"description": "Opaque client conversation identifier used only to bind a completed receipt.",
"type": "string"
},
"receipt_idempotency_key": {
"description": "Client key for replay-safe delivery of a completed activation receipt.",
"type": "string"
}
},
"type": "object"
},
"name": "get_activation_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"activation_receipt": {
"type": [
"object",
"null"
]
},
"activation_session_id": {
"type": [
"string",
"null"
]
},
"business_id": {
"type": "string"
},
"call_readiness": {
"type": "object"
},
"command_center_unlocked": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"next_action": {
"type": "string"
},
"notification_attempts": {
"items": {
"type": "object"
},
"type": "array"
},
"owner_phone_on_file": {
"description": "Whether the owner's own mobile number is on file for SMS alerts or ring-first. Its absence does not invalidate an email-confirmed private test or require forwarding.",
"type": "boolean"
},
"proof": {
"type": "object"
},
"routes": {
"items": {
"type": "object"
},
"type": "array"
},
"state": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read assigned installations, grouped support incidents, accepted billing evidence (also billing:read), your clients (line, last 7 days of calls and qualified leads, each client's alert settings, what clients see about you and your own client-activity alerts), or inventory one authorized client's saved facts and actual channel readiness. Suggestions and unknowns remain explicit.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"after": {
"format": "uuid",
"type": "string"
},
"businessId": {
"format": "uuid",
"type": "string"
},
"partnerId": {
"format": "uuid",
"type": "string"
},
"resource": {
"enum": [
"installations",
"support",
"billing",
"discovery",
"clients"
],
"type": "string"
}
},
"required": [
"resource",
"partnerId"
],
"type": "object"
},
"name": "get_agency_workspace",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"state": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read an agent's settings as the owner edits them: the editable inbound, outbound and text prompts, greeting, voice (with its list_voices id when it has one), model, call length, transfer settings, and the call summary and lead score instructions. Read this before update_agent_config: inbound_prompt there replaces the whole prompt, so edit the text returned here.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent ID (from list_agents).",
"type": "string"
},
"business_id": {
"description": "Business ID. Needed only when the agent belongs to more than one.",
"type": "string"
}
},
"required": [
"agent_id"
],
"type": "object"
},
"name": "get_agent_config",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent": {
"type": [
"object",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Discover the external agent connection, signed webhook configuration, scoped API operation catalog, channel readiness and remaining runtime requirements. Requires agents:read, sms:read and webhooks:read. Configuration does not prove delivery or recipient consent.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"type": "object"
},
"name": "get_agent_connection",
"outputSchema": null
},
{
"description": "Get a dashboard summary (lead counts by status, conversion rate, call volume and duration, top agents, and business outcomes by type) over a recent time window.",
"inputSchema": {
"properties": {
"days": {
"description": "Lookback window in days (default 30, max 90)",
"maximum": 90,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "get_analytics",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agents": {
"type": "object"
},
"calls": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"leads": {
"type": "object"
},
"outcomes": {
"type": "object"
},
"outcomes_total": {
"type": "integer"
},
"period": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Get plan terms and usage for accessible businesses. No-card trials report 25 lifetime minutes, zero price and no overage; paid plans report the mapped subscription price and billing-cycle usage. Answered-call allowance usage is the raw billable call count, matching dashboard and right-sizing. A separate weighted count is informational only, not allowance consumption or right-sizing. Phone allowance includes purchased extra lines. A balance does not prove activation or inbound routing. Unavailable billing data returns an error.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "get_balance",
"outputSchema": {
"additionalProperties": true,
"properties": {
"businesses": {
"items": {
"properties": {
"allowance_model": {
"enum": [
"minutes",
"answered_calls"
],
"type": "string"
},
"answered_calls_allowance": {
"type": [
"number",
"null"
]
},
"answered_calls_raw": {
"description": "Unweighted billable call count for reporting.",
"type": [
"number",
"null"
]
},
"answered_calls_used": {
"description": "Raw billable call count used for allowance reporting, matching dashboard and right-sizing; null for minute plans.",
"type": [
"number",
"null"
]
},
"answered_calls_weighted": {
"description": "Informational only, not allowance consumption or right-sizing: ordinary calls 1, human-answered silent-listen calls 0.5; null for minute plans.",
"type": [
"number",
"null"
]
},
"business_id": {
"type": "string"
},
"minutes_allowance": {
"type": "number"
},
"minutes_used": {
"type": "number"
},
"overage_allowed": {
"type": "boolean"
},
"period_end": {
"description": "Null for lifetime trial usage; does not imply the trial cannot expire.",
"type": [
"string",
"null"
]
},
"period_kind": {
"enum": [
"lifetime_trial",
"billing_cycle"
],
"type": "string"
},
"period_start": {
"type": "string"
},
"phone_numbers": {
"description": "Active registered numbers, including unassigned numbers.",
"type": "integer"
},
"phone_numbers_allowance": {
"type": "integer"
},
"plan_key": {
"type": "string"
},
"plan_name": {
"type": "string"
},
"price_monthly": {
"description": "Mapped subscription base price in USD; zero for no-card trial. Excludes add-ons and tax.",
"type": "number"
},
"subscription_status": {
"type": "string"
}
},
"required": [
"business_id",
"plan_key",
"plan_name",
"price_monthly",
"allowance_model",
"minutes_used",
"minutes_allowance",
"answered_calls_used",
"answered_calls_raw",
"answered_calls_weighted",
"answered_calls_allowance",
"phone_numbers",
"phone_numbers_allowance",
"subscription_status",
"overage_allowed",
"period_start",
"period_end",
"period_kind"
],
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read who gets the monthly invoice email for a business. Every paid invoice is always emailed to the business owner (returned masked); up to 3 extra addresses, such as a bookkeeper or office inbox, get the same email.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
}
},
"type": "object"
},
"name": "get_billing_contacts",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"extra_emails": {
"items": {
"type": "string"
},
"type": "array"
},
"max_extra_emails": {
"type": "integer"
},
"monthly_invoice_email": {
"type": "boolean"
},
"owner_email": {
"description": "The owner's login email, masked. The owner always gets every invoice.",
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read back what a business already has: profile details, how many agents are configured, and recent call volume. This shows whether a business number that answers missed calls already exists. When the business has no working phone line yet, `next_step` names the tool that sets one up.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional, defaults to first accessible business)",
"type": "string"
}
},
"type": "object"
},
"name": "get_business_info",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_count": {
"type": "integer"
},
"business": {
"type": "object"
},
"calls_last_30_days": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"next_step": {
"description": "Present when the business has no working phone line yet: code, the tool to call next, and the instruction to follow. Null once the line is set up.",
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read tenant-scoped business-verification document references, pending/approved/rejected staff-review states and secure upload requirements. No file bytes, storage paths, signed URLs or tax identifiers. Uploads happen on the secure owner page, by an admin; rejected documents can be corrected and uploaded again. Internal staff verification is separate from carrier registration. Reviewer notes are returned as staff-written data.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_business_verification",
"outputSchema": {
"additionalProperties": true,
"properties": {
"documents": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"has_more": {
"type": "boolean"
},
"provider_submission": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"upload_requirements": {
"type": "object"
},
"upload_url": {
"type": "string"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the recording notice and AI notice callers hear before the greeting, and when each plays: always, state_gated (only for callers in states whose law calls for it, e.g. all-party-consent states for recording), or never. Shows the defaults when the business has not set its own.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
}
},
"type": "object"
},
"name": "get_call_disclosures",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"is_default": {
"type": "boolean"
},
"settings": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Get the real call recording URL for a call so reviewers can listen to the voice/audio instead of relying only on the transcript.",
"inputSchema": {
"properties": {
"call_id": {
"description": "The KaiCalls call ID to get the recording for",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "get_call_recording",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call": {
"properties": {
"agent_id": {
"type": [
"string",
"null"
]
},
"agent_name": {
"type": [
"string",
"null"
]
},
"business_id": {
"type": "string"
},
"conversation_id": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"duration_seconds": {
"type": [
"number",
"null"
]
},
"id": {
"type": "string"
},
"recording_url": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
}
},
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"recording_available": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read a business's CallRail call-tracking setup. action=status returns the connected CallRail account, which CallRail companies feed which business, every company the saved key can see (with its company_id), and the businesses you can link them to. action=list_trackers (with link_id from status) returns that company's tracking numbers, where each one rings now, and whether it already rings a KaiCalls line. If nothing is connected yet, ask the person for their CallRail API key and use manage_callrail connect.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"status",
"list_trackers"
],
"type": "string"
},
"business_id": {
"format": "uuid",
"type": "string"
},
"link_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_callrail",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List an agent's recent config-change audit trail (change_type, change_source, old/new value, timestamp) — the same change log the owner hears when they call their line and ask what changed. Every change KaiCalls makes to an agent (via update_agent_config, configure_agent_business_rules, the owner's call-in line, or the dashboard) is logged here. Rows carry no version number; to undo a change, pick a version from list_config_versions and use rollback_config.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent ID to fetch change history for.",
"type": "string"
},
"limit": {
"description": "Max results to return (default 20, max 100).",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"agent_id"
],
"type": "object"
},
"name": "get_change_history",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_id": {
"type": "string"
},
"changes": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read customer channel setup. Phone calls report configured number resources only: state configured or needs_setup, with canSend/canReceive null because operational availability is unknown. SMS has state not_checked and null send/receive flags; shared_setup_state retains the existing configuration summary, not recipient-specific permission. Registration detail requires billing:read; this SMS-scope summary reads no new billing details. Other channels retain their existing states and flags. private_test_readiness checks owner-private call setup only when the token also has agents:read; otherwise it is not_checked with reconnect scope guidance. Private testing does not establish customer coverage or outbound call permission, which remain not_checked. Email includes separate managedEmail campaign sender readiness; a connected mailbox does not prove campaign approval or delivery. Read-only; changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_channel_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"channels": {
"items": {
"allOf": [
{
"if": {
"properties": {
"channel": {
"const": "sms"
}
},
"required": [
"channel"
]
},
"then": {
"properties": {
"canReceive": {
"type": "null"
},
"canSend": {
"type": "null"
},
"state": {
"const": "not_checked"
}
},
"required": [
"state",
"canSend",
"canReceive",
"shared_setup_state",
"shared_setup_next_step",
"sending_permission",
"delivery",
"account_route",
"recipient_checks"
]
}
}
],
"properties": {
"account_route": {
"enum": [
"not_checked"
],
"type": "string"
},
"availability": {
"enum": [
"live",
"built_off",
"planned"
],
"type": "string"
},
"canReceive": {
"type": [
"boolean",
"null"
]
},
"canSend": {
"type": [
"boolean",
"null"
]
},
"channel": {
"type": "string"
},
"configuration_state": {
"enum": [
"number_assigned",
"number_missing"
],
"type": "string"
},
"delivery": {
"enum": [
"not_checked"
],
"type": "string"
},
"label": {
"type": "string"
},
"nextStep": {
"type": [
"object",
"null"
]
},
"recipient_checks": {
"enum": [
"not_checked"
],
"type": "string"
},
"sending_permission": {
"enum": [
"not_checked"
],
"type": "string"
},
"shared_setup_next_step": {
"type": [
"object",
"null"
]
},
"shared_setup_state": {
"enum": [
"ready",
"needs_setup",
"blocked",
"not_available"
],
"type": "string"
},
"state": {
"enum": [
"not_checked",
"configured",
"ready",
"needs_setup",
"blocked",
"not_available"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"customer_coverage": {
"enum": [
"not_checked"
],
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"outbound_call_permission": {
"enum": [
"not_checked"
],
"type": "string"
},
"private_test_readiness": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"next_tool": {
"enum": [
"get_activation_status"
],
"type": "string"
},
"required_scope": {
"enum": [
"agents:read"
],
"type": "string"
},
"status": {
"enum": [
"not_checked"
],
"type": "string"
}
},
"required": [
"status",
"required_scope",
"next_tool"
]
},
{
"additionalProperties": false,
"properties": {
"next_action": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"ready",
"owner_required",
"entitlement_required",
"number_not_ready",
"session_stale",
"unavailable"
],
"type": "string"
}
},
"required": [
"status",
"next_action"
]
}
],
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read a Stripe-verified subscription checkout receipt for a business you own. Requires business_id and session_id from checkout. Confirmed billing does not prove agent, number, or call activation; get_activation_status reports setup proof. This tool never creates checkout or retries provisioning.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"session_id": {
"type": "string"
}
},
"required": [
"business_id",
"session_id"
],
"type": "object"
},
"name": "get_checkout_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"activation_verified": {
"type": "boolean"
},
"billing_only": {
"type": "boolean"
},
"checkout": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Coach the business's agent. With call_id: what the agent did well and what to change on that call, each point with the caller's or agent's exact words, the second it happened, and a one-line rule that would fix it (teach it with teach_coaching_rule). Without call_id: the agent's recurring habits across recent calls (how often, example calls, and whether a rule taught for it has worked). Read-only.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Habits for one agent only (optional).",
"type": "string"
},
"business_id": {
"description": "Business ID. Required when the key can reach more than one business.",
"type": "string"
},
"call_id": {
"description": "Coach one call. Omit for habits across calls.",
"type": "string"
},
"days": {
"description": "Window for habits, in days (default 30).",
"maximum": 90,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "get_coaching",
"outputSchema": {
"additionalProperties": true,
"properties": {
"coaching": {
"type": [
"object",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"habits": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the consent proof for one phone number at a business: for service texts, marketing texts, calls and WhatsApp, the current status, when consent was given or taken back, how (web form, keyword, call, manual, API), the exact wording shown, and the stored proof (form page, form time, submission id), plus up to 50 history entries, newest first. Use it to answer a carrier or customer asking how someone opted in. IP addresses are never returned. found false means no consent record exists for that number. Read-only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"phone": {
"description": "Phone number, E.164 preferred (+15551234567).",
"type": "string"
}
},
"required": [
"business_id",
"phone"
],
"type": "object"
},
"name": "get_consent_proof",
"outputSchema": {
"additionalProperties": true,
"properties": {
"channels": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"found": {
"type": "boolean"
},
"history": {
"items": {
"type": "object"
},
"type": "array"
},
"history_truncated": {
"type": "boolean"
},
"phone_number": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Get a single SMS conversation thread by ID.",
"inputSchema": {
"properties": {
"conversation_id": {
"description": "The conversation ID to fetch.",
"type": "string"
}
},
"required": [
"conversation_id"
],
"type": "object"
},
"name": "get_conversation",
"outputSchema": {
"additionalProperties": true,
"properties": {
"conversation": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read a business's email campaigns: its sending addresses and their setup readiness, recent campaigns with status, revision fingerprint and outcome counts, and the customers who can be emailed (recorded consent, not on the do-not-email list). Pass campaign_id for one campaign, or sender_id for the DNS records that sending address's domain needs. Read-only; any member of the business can read.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"campaign_id": {
"description": "Optional: one campaign.",
"type": "string"
},
"sender_id": {
"description": "Optional: that sender's domain setup records instead of the campaign view.",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_email_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"audience": {
"items": {
"type": "object"
},
"type": "array"
},
"campaigns": {
"items": {
"type": "object"
},
"type": "array"
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"records": {
"items": {
"type": "object"
},
"type": "array"
},
"senders": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read an owner-authorized extra-number request. Billing, assignment and live activation are distinct. Unknown checkout or provider outcomes retain the original request and number, so no replacement purchase is needed or started.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"request_id": {
"type": "string"
}
},
"required": [
"business_id",
"request_id"
],
"type": "object"
},
"name": "get_extra_number_status",
"outputSchema": null
},
{
"description": "Answer \"what did I miss?\" in one read: the business's calls since a moment (default the last 24 hours, at most 30 days) with who called and what they wanted, every unheard voicemail with its transcript, texts that came in (needs sms:read), and open to-dos and callbacks. Read-only. Follow up with get_transcript, send_message to reply, or list_recent_calls / list_sms_messages to search further back.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Narrow to one accessible business (optional).",
"type": "string"
},
"since": {
"description": "ISO-8601 date or time to start from (optional, default 24 hours ago; clamped to the last 30 days).",
"type": "string"
}
},
"type": "object"
},
"name": "get_inbox",
"outputSchema": {
"additionalProperties": true,
"properties": {
"calls": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"has_more": {
"type": "object"
},
"sections_not_read": {
"items": {
"type": "string"
},
"type": "array"
},
"since": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"texts": {
"items": {
"type": "object"
},
"type": [
"array",
"null"
]
},
"todos": {
"items": {
"type": "object"
},
"type": "array"
},
"voicemails": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Get full details for a single lead by ID, including the latest AI lead score and explanation.",
"inputSchema": {
"properties": {
"lead_id": {
"description": "The lead ID to fetch",
"type": "string"
}
},
"required": [
"lead_id"
],
"type": "object"
},
"name": "get_lead",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"lead": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the authorized advertiser's live Google Local Services aggregate account report, including actual spend, currency and charged lead totals. Requires linked manager-account access. Dates are calendar dates inclusive at both ends. Source may lag by 30 minutes. Connected phone calls means duration over 30 seconds; responsiveness is the previous 90 days. This is not signed-case revenue or lead-rating reporting.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"connection_id": {
"format": "uuid",
"type": "string"
},
"end_date": {
"format": "date",
"type": "string"
},
"start_date": {
"format": "date",
"type": "string"
}
},
"required": [
"business_id",
"connection_id",
"start_date",
"end_date"
],
"type": "object"
},
"name": "get_lsa_account_report",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the latest 200 synced Google LSA conversation events for an LSA lead, including customer and advertiser messages. History is as current as the last sync.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"lead_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id",
"lead_id"
],
"type": "object"
},
"name": "get_lsa_conversations",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Report LSA lead counts, types, observed statuses, ratings and credit counts for an explicit UTC window (start inclusive, end exclusive). Includes sync freshness and completeness. Removed unrated leads are counted separately because they cannot be rated here. Financial amounts, signed cases and response-time metrics are unavailable in this source and cannot be derived from counts.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"end": {
"format": "date-time",
"type": "string"
},
"start": {
"format": "date-time",
"type": "string"
}
},
"required": [
"business_id",
"start",
"end"
],
"type": "object"
},
"name": "get_lsa_report",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Inspect Google LSA account selection and sync freshness, with setup steps. Saved configuration never proves a live workflow. Cloud-project production access is not shown here; Google Cloud reports it.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_lsa_setup",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the meetings Kai was sent into (newest first), or one meeting by id with its live status, minutes used and summary, plus the plan's remaining meeting minutes this month.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access several businesses).",
"type": "string"
},
"id": {
"description": "Meeting id (optional; omit to list recent meetings).",
"type": "string"
}
},
"type": "object"
},
"name": "get_meeting",
"outputSchema": {
"additionalProperties": true,
"properties": {
"allowance": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"meetings": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read a business's Nimbata call-tracking setup: the connected Nimbata account, which Nimbata projects feed which business (with when each last synced and how many calls matched), the projects the saved token can see, and the businesses you can link them to.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"status"
],
"type": "string"
},
"business_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_nimbata",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the business-level operational setup of a live account: staff alert recipients, SMS/email alert flags, escalation rules, textable send-link entries, and assigned agent voice/model/greeting metadata.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional, defaults to first accessible business)",
"type": "string"
}
},
"type": "object"
},
"name": "get_operational_settings",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agents": {
"items": {
"type": "object"
},
"type": "array"
},
"available_setup_tools": {
"items": {
"type": "string"
},
"type": "array"
},
"business": {
"type": "object"
},
"business_links": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"next_step": {
"description": "Present when the business has no working phone line yet: code, the tool to call next, and the instruction to follow. Null once the line is set up.",
"type": [
"object",
"null"
]
},
"notification_settings": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Which number Kai's outbound calls show: the person's own verified number or the KaiCalls line. Also confirms a verification started with start_own_caller_id once the person has typed the code. state is none, pending, verified or failed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"type": "object"
},
"name": "get_own_caller_id",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"own_caller_id": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read how calls ring on the business's hosted phone system: which cells and desk phones ring, for how many seconds, and whether after-hours callers go straight to Kai. Reconciled from the phone system on every call. Returns 409 when the hosted phone system is not set up for this business.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access multiple businesses).",
"type": "string"
}
},
"type": "object"
},
"name": "get_phone_flow",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_hours_available": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"flow": {
"type": "object"
},
"kai_extension": {
"type": "string"
},
"line": {
"type": [
"string",
"null"
]
},
"readback": {
"description": "One-sentence plain-English description.",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read saved phone-system configuration: extension, resource IDs (never secrets), assigned line, and agreement. phone_system_configuration.configuration_allows_calls means provisioned resources plus a permitting agreement only; it does not verify calls can connect. ready_for_calls is null because operational availability is unknown. private_test_readiness uses the existing owner-private call setup authority only with agents:read; otherwise not_checked. Customer coverage and outbound call permission remain not_checked. This read differs from the shared phone-system API configuration flag and changes nothing.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access multiple businesses).",
"type": "string"
}
},
"type": "object"
},
"name": "get_phone_system_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"customer_coverage": {
"enum": [
"not_checked"
],
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"ids": {
"type": "object"
},
"kai_extension": {
"type": [
"string",
"null"
]
},
"line": {
"type": [
"string",
"null"
]
},
"next_step": {
"type": "string"
},
"outbound_call_permission": {
"enum": [
"not_checked"
],
"type": "string"
},
"phone_system_configuration": {
"additionalProperties": false,
"properties": {
"agreement": {
"type": "string"
},
"configuration_allows_calls": {
"type": "boolean"
},
"provisioned": {
"type": "boolean"
}
},
"required": [
"provisioned",
"agreement",
"configuration_allows_calls"
],
"type": "object"
},
"private_test_readiness": {
"oneOf": [
{
"additionalProperties": false,
"properties": {
"next_tool": {
"enum": [
"get_activation_status"
],
"type": "string"
},
"required_scope": {
"enum": [
"agents:read"
],
"type": "string"
},
"status": {
"enum": [
"not_checked"
],
"type": "string"
}
},
"required": [
"status",
"required_scope",
"next_tool"
]
},
{
"additionalProperties": false,
"properties": {
"next_action": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"ready",
"owner_required",
"entitlement_required",
"number_not_ready",
"session_stale",
"unavailable"
],
"type": "string"
}
},
"required": [
"status",
"next_action"
]
}
],
"type": "object"
},
"provisioned": {
"type": "boolean"
},
"provisioned_at": {
"type": [
"string",
"null"
]
},
"ready_for_calls": {
"type": "null"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read how the business screens scam calls: the mode (off; label, the default, which answers every call and marks likely scams in the call log; or screen, which sends callers with a strong scam sign to a take-a-message screen), the numbers that are never screened, and the most recent calls caught as scams.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
}
},
"type": "object"
},
"name": "get_scam_screening",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"is_default": {
"type": "boolean"
},
"recent_flagged_calls": {
"items": {
"type": "object"
},
"type": "array"
},
"settings": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read where one business stands on setup: plan, phone number, texting registration, WhatsApp, call and lead alerts, connected mailbox for follow-up email, and email campaign sender. Each step has a state (done, in_progress, needs_owner, needs_action or unavailable) and one next action: either the tool that moves it forward, or the page the owner must open for steps only they can do, such as paying, typing their EIN or signing in to Facebook or Google. Read-only; changes nothing and contacts no one.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business to check.",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_setup_checklist",
"outputSchema": {
"additionalProperties": true,
"properties": {
"checklist": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read an owner-authorized setup recovery request by its business and idempotency key. Running requests are never automatically stolen, including stale requests. A ready receipt does not prove live activation.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
}
},
"required": [
"business_id",
"idempotency_key"
],
"type": "object"
},
"name": "get_setup_recovery_status",
"outputSchema": null
},
{
"description": "Read the business's own plan: no_paid_plan, active, or canceling, with the plan name and the renewal or end date. Use before cancel_subscription to tell the owner what will happen.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
}
},
"type": "object"
},
"name": "get_subscription",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"manage_url": {
"type": "string"
},
"period_end": {
"type": [
"string",
"null"
]
},
"plan": {
"type": [
"string",
"null"
]
},
"state": {
"enum": [
"no_paid_plan",
"active",
"canceling",
"needs_review"
],
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read where a business stands on its own carrier registration for business texting: saved details (never the EIN; only whether one is on file), payment, filing stage, whether sales texts are allowed, and the one next step. In MCP, `known` excludes fields the canonical flow still requires the owner to confirm; `suggestions` preserves those nonprivate values and available provenance. `missing` is the ordered outstanding field-question list, with missing_value or confirmation_required reasons; `next_question` is its first item. `question_progress` counts field questions including next, not website screens. Website screens group several fields and may include a private identity step; unequal counts can be valid. The MCP presentation separates configured registration/enrollment from recipient-specific sending permission and delivery, which remain not_checked. A null own registration does not prove an enrolled platform route cannot text; configured lines do not prove a send is authorized. Dashboard/API presentation is unchanged. Pass check=true to also run the pre-filing check: every problem a carrier reviewer would reject the registration on (business details, campaign wording, website, privacy policy, texting terms, opt-in page), each as `prefiling_check.items` with a plain fix, so it can be fixed before anything is paid. Read-only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"check": {
"description": "Also run the pre-filing check and return prefiling_check (ready, items with title and fix).",
"type": "boolean"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_text_registration",
"outputSchema": {
"additionalProperties": true,
"properties": {
"account_route": {
"enum": [
"not_checked"
],
"type": "string"
},
"addon": {
"type": "object"
},
"chasers": {
"type": "object"
},
"delivery": {
"enum": [
"not_checked"
],
"type": "string"
},
"ein_on_file": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"known": {
"additionalProperties": false,
"properties": {
"brand_name": {
"type": "string"
},
"business_type": {
"type": "string"
},
"city": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_first_name": {
"type": "string"
},
"contact_job_position": {
"type": "string"
},
"contact_last_name": {
"type": "string"
},
"contact_phone": {
"type": "string"
},
"contact_title": {
"type": "string"
},
"industry": {
"type": "string"
},
"legal_business_name": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"text_types": {
"type": "string"
},
"website_url": {
"type": "string"
}
},
"type": "object"
},
"missing": {
"items": {
"additionalProperties": false,
"properties": {
"field": {
"enum": [
"legal_business_name",
"brand_name",
"business_type",
"industry",
"website_url",
"street",
"city",
"state",
"postal_code",
"contact_first_name",
"contact_last_name",
"contact_email",
"contact_phone",
"contact_job_position",
"contact_title",
"text_types"
],
"type": "string"
},
"question": {
"type": "string"
},
"reason": {
"enum": [
"missing_value",
"confirmation_required"
],
"type": "string"
},
"suggestion": {
"type": "string"
},
"why": {
"type": "string"
}
},
"required": [
"field",
"question",
"reason"
],
"type": "object"
},
"type": "array"
},
"next_question": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"field": {
"enum": [
"legal_business_name",
"brand_name",
"business_type",
"industry",
"website_url",
"street",
"city",
"state",
"postal_code",
"contact_first_name",
"contact_last_name",
"contact_email",
"contact_phone",
"contact_job_position",
"contact_title",
"text_types"
],
"type": "string"
},
"question": {
"type": "string"
},
"reason": {
"enum": [
"missing_value",
"confirmation_required"
],
"type": "string"
},
"suggestion": {
"type": "string"
},
"why": {
"type": "string"
}
},
"required": [
"field",
"question",
"reason"
],
"type": "object"
},
{
"type": "null"
}
]
},
"next_step": {
"type": "string"
},
"next_step_text": {
"type": "string"
},
"prefiling_check": {
"type": [
"object",
"null"
]
},
"question_progress": {
"additionalProperties": false,
"properties": {
"includes_next_question": {
"const": true
},
"remaining": {
"minimum": 0,
"type": "integer"
},
"unit": {
"enum": [
"field_questions"
],
"type": "string"
}
},
"required": [
"unit",
"remaining",
"includes_next_question"
],
"type": "object"
},
"recipient_checks": {
"enum": [
"not_checked"
],
"type": "string"
},
"registration": {
"type": [
"object",
"null"
]
},
"sending_permission": {
"enum": [
"not_checked"
],
"type": "string"
},
"setup_url": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"suggestions": {
"additionalProperties": false,
"properties": {
"brand_name": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"business_type": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"city": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_email": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_first_name": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_job_position": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_last_name": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_phone": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"contact_title": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"industry": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"legal_business_name": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"postal_code": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"state": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"street": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"text_types": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"website_url": {
"additionalProperties": false,
"properties": {
"source": {
"enum": [
"saved",
"caller_id",
"business",
"owner",
"default"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}
},
"type": "object"
},
"textingLines": {
"items": {
"properties": {
"configuration_state": {
"enum": [
"registration_or_enrollment_recorded"
],
"type": "string"
},
"number": {
"type": "string"
},
"sending_permission": {
"enum": [
"not_checked"
],
"type": "string"
},
"state": {
"enum": [
"configured",
"adding",
"in_review",
"sent_back",
"registering_next",
"not_registered",
"paused"
],
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"number",
"state",
"text",
"sending_permission"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Get the transcript and summary of a completed call, plus its insights: Kai's lead score for the call, the caller's sentiment, the intake answers collected, who did the talking, and the lead journey (channel, landing page, first contact, number of calls).",
"inputSchema": {
"properties": {
"call_id": {
"description": "The call ID to get the transcript for",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "get_transcript",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"insights": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"transcript": {
"type": [
"string",
"null"
]
},
"transcript_available": {
"type": "boolean"
},
"transcript_length": {
"type": "integer"
},
"transcript_truncated": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read one business's KaiCalls trust level (Sprout, Verified, Trusted, Pro, Partner): the current level, the steps to the next one with progress, what each level unlocks, today's outbound calls and texts against current effective account limits, and any hold. Badge progress does not itself establish higher call or text caps. focus 'ladder' explains every level; focus 'level' with level explains one. Read-only: returns saved standing or computes missing/stale standing without saving it or sending notifications. recheck_trust_level recomputes and saves current standing. Levels are earned, never set: no tool can raise one.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token reaches exactly one business).",
"type": "string"
},
"focus": {
"description": "'standing' (default): the current level and next steps. 'ladder': every level. 'level': the one named in level. 'outbound': today's outbound calls and texts against the limits this level allows, and the step that raises them.",
"enum": [
"standing",
"ladder",
"level",
"outbound"
],
"type": "string"
},
"level": {
"description": "A level key or name, e.g. 'pro'. Used with focus 'level'.",
"type": "string"
}
},
"type": "object"
},
"name": "get_trust_level",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"computed_at": {
"type": "string"
},
"detail": {
"type": [
"object",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"held": {
"type": [
"string",
"null"
]
},
"ladder": {
"items": {
"type": "object"
},
"type": "array"
},
"level": {
"type": "object"
},
"line": {
"type": "string"
},
"meters": {
"items": {
"type": "object"
},
"type": "array"
},
"moved": {
"enum": [
"up",
"down",
null
],
"type": [
"string",
"null"
]
},
"next": {
"type": [
"object",
"null"
]
},
"next_opens_later": {
"type": "boolean"
},
"previous_level": {
"type": [
"string",
"null"
]
},
"progress": {
"type": "number"
},
"quests": {
"items": {
"type": "object"
},
"type": "array"
},
"rechecked": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List recent API usage events (endpoint, method, status code, cost) for the caller's account.",
"inputSchema": {
"properties": {
"end": {
"description": "ISO date/time upper bound (optional).",
"type": "string"
},
"limit": {
"description": "Max results to return (default 100, max 500).",
"maximum": 500,
"minimum": 1,
"type": "integer"
},
"start": {
"description": "ISO date/time lower bound (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "get_usage",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"has_more": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"usage": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the configured outbound webhook(s) for a business, including supported event types.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
}
},
"type": "object"
},
"name": "get_webhook",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"events": {
"items": {
"type": "string"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"webhooks": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Check whether WhatsApp is connected on a business's KaiCalls number, read live from the carrier. Connected only once the number is verified for WhatsApp; otherwise says whether the owner's link is still waiting, expired or failed.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "get_whatsapp_status",
"outputSchema": {
"additionalProperties": true,
"properties": {
"connected": {
"type": "boolean"
},
"connections": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Join a live errand call. take_over connects the person's own phone; listen returns a signed-in dashboard link.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"call_id": {
"description": "The KaiCalls call ID from make_call",
"type": "string"
},
"mode": {
"description": "take_over rings the person and connects them; listen returns a dashboard link",
"enum": [
"take_over",
"listen"
],
"type": "string"
}
},
"required": [
"call_id",
"mode"
],
"type": "object"
},
"name": "join_call",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"listen_link": {
"type": "string"
},
"mode": {
"type": "string"
},
"replayed": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"takeover_status": {
"type": "string"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send Kai into a Zoom, Google Meet, Microsoft Teams or Webex meeting by its link. Kai joins under the agent name, takes notes, and emails the owner a summary when the meeting ends. If the meeting has a waiting room, the host must admit Kai. In the default listen mode it answers out loud when someone says its name and counts against the plan's monthly meeting minutes (a business whose plan includes none gets its first hour free, once); avatar mode joins with a talking video face and counts one avatar meeting.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Which agent joins (optional; defaults to the business's first agent).",
"type": "string"
},
"avatar_id": {
"description": "Avatar mode only: which stock face to use (optional; an unknown id returns the list of valid ones).",
"type": "string"
},
"bot_name": {
"description": "Name shown in the meeting and the name people say to get a reply (optional; defaults to the agent's name). Must be a short, speakable name.",
"type": "string"
},
"business_id": {
"description": "Business ID (required when the token can access several businesses).",
"type": "string"
},
"camera_image_url": {
"description": "Public https link to a .jpg shown as the camera tile (optional).",
"type": "string"
},
"instructions": {
"description": "Context for this meeting only, e.g. \"This is an onboarding call for a new customer; they need help with setup\" (optional, up to 2000 characters).",
"maxLength": 2000,
"type": "string"
},
"meeting_url": {
"description": "The meeting link, e.g. https://meet.google.com/abc-defg-hij or a zoom.us join link.",
"type": "string"
},
"mode": {
"description": "'listen' (default): joins with a still camera tile and answers out loud when someone says its name. 'avatar': joins with a talking video face; counts as one avatar meeting (separate from meeting minutes; every business gets one free), stays on camera for the first 30 minutes, then continues voice-only and leaves at 60 minutes.",
"enum": [
"listen",
"avatar"
],
"type": "string"
}
},
"required": [
"meeting_url"
],
"type": "object"
},
"name": "join_meeting",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"meeting": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Start or resume an existing outbound call campaign so Kai begins calling its leads. Needs campaign_id and agent_id (an agent assigned to the same business), the calls:write scope and an admin role in the business. Queues the campaign's pending calls within its call windows; real people get phone calls once it runs. A queued result does not mean any call was answered or completed. pause_call_campaign stops it. Not for email campaigns.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"agent_id": {
"description": "The agent that places the calls. Must belong to the same business.",
"type": "string"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"campaign_id": {
"description": "The call campaign, from list_campaigns.",
"type": "string"
}
},
"required": [
"campaign_id",
"agent_id"
],
"type": "object"
},
"name": "launch_call_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"cancelled_attempts": {
"type": [
"integer",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"paused_jobs": {
"type": [
"integer",
"null"
]
},
"queued": {
"type": [
"integer",
"null"
]
},
"reset_leads": {
"type": [
"integer",
"null"
]
},
"sequence_id": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Queue an owner-approved email campaign for sending to real customers, within its daily limit. Business owner only. Emails cannot be unsent once delivered; cancel_email_campaign stops what has not gone out yet. A queued result is not proof any email was delivered. Campaign email only goes from the business’s own verified sending domain, to customers with recorded email permission who are not on the do-not-email list, within the daily amount the business’s Kai level allows.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"campaign_id": {
"description": "The approved campaign.",
"type": "string"
}
},
"required": [
"business_id",
"campaign_id"
],
"type": "object"
},
"name": "launch_email_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Have Kai leave a video meeting it is in, or stop trying to join one. Kai drops out of the live call for everyone in it and stops taking notes; this cannot be undone, and joining again takes a new join_meeting request. Notes taken so far are kept and can be read with get_meeting.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access several businesses).",
"type": "string"
},
"id": {
"description": "Meeting id from join_meeting or get_meeting.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "leave_meeting",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"meeting": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the KaiCalls agents on the authenticated account. Shows whether this business already has a secretary answering its calls.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID to filter by (optional, must be accessible)",
"type": "string"
},
"limit": {
"description": "Max results to return (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "list_agents",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agents": {
"items": {
"type": "object"
},
"type": "array"
},
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filters": {
"type": "object"
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List outbound call campaigns for the authenticated business.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max results to return (default 25, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
},
"status": {
"description": "Filter by campaign status (optional)",
"type": "string"
}
},
"type": "object"
},
"name": "list_campaigns",
"outputSchema": {
"additionalProperties": true,
"properties": {
"campaigns": {
"items": {
"type": "object"
},
"type": "array"
},
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filters": {
"type": "object"
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the saved versions of an agent's settings, newest first: what saved each one (source), what changed (diff_summary), who (created_by) and which version a rollback came from. Secrets are never included. Pass `version` to fetch one version's full saved settings (config_snapshot). That snapshot holds the compiled prompt; to edit the prompt, read get_agent_config instead.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Agent ID (required).",
"type": "string"
},
"limit": {
"description": "Max versions to return when listing (optional, default 50, max 100).",
"type": "integer"
},
"version": {
"description": "Fetch a single version by its per-agent version_number, including its redacted config_snapshot (optional; omit to list).",
"type": "integer"
}
},
"required": [
"agent_id"
],
"type": "object"
},
"name": "list_config_versions",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"version": {
"type": [
"object",
"null"
]
},
"versions": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List SMS conversation threads (counterparty timeline metadata) for the authenticated business, most recent first.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max results to return (default 50, max 100).",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "list_conversations",
"outputSchema": {
"additionalProperties": true,
"properties": {
"conversations": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"has_more": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List saved test scenarios for an agent (or all accessible agents). A new agent has none; create_eval adds one.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Filter by agent ID (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "list_evals",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"evals": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List agent knowledge base entries for a business.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"category": {
"description": "Filter by category (optional).",
"type": "string"
},
"query": {
"description": "Free-text search over title/content (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "list_knowledge",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"knowledge": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List leads for the authenticated business, with optional status/source/agent filters. Includes the latest AI lead score when available.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "Filter by agent ID (optional)",
"type": "string"
},
"limit": {
"description": "Max results to return (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
},
"source": {
"description": "Filter by lead source (optional)",
"type": "string"
},
"status": {
"description": "Filter by lead status (optional)",
"type": "string"
}
},
"type": "object"
},
"name": "list_leads",
"outputSchema": {
"additionalProperties": true,
"properties": {
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filters": {
"type": "object"
},
"has_more": {
"type": "boolean"
},
"leads": {
"items": {
"type": "object"
},
"type": "array"
},
"limit": {
"type": "integer"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List synced Google LSA leads, charge and credit states, source IDs and rating details. The returned LSA lead id identifies the lead in LSA commands; the separate lead_id field links to the CRM.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"limit": {
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"maximum": 100000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "list_lsa_leads",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List phone numbers assigned to the accessible business(es), with capability and compliance flags. Assignment does not prove a successful inbound test or customer coverage. get_activation_status reports current readiness and private-test proof. Forwarding is an optional customer route.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID to filter by (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "list_numbers",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"numbers": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List a business-scoped timeline of compact call-runtime events and redacted integration-delivery attempts. Uses bounded keyset pagination.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"call_id": {
"description": "Runtime-event call UUID filter.",
"type": "string"
},
"connection_id": {
"description": "Integration connection UUID filter.",
"type": "string"
},
"conversation_id": {
"description": "Runtime-event filter.",
"type": "string"
},
"correlation_id": {
"description": "Runtime-event filter.",
"type": "string"
},
"cursor": {
"description": "Opaque next_cursor returned by the previous page.",
"type": "string"
},
"event_type": {
"description": "Runtime-event filter.",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"object_id": {
"description": "Integration-delivery filter.",
"type": "string"
},
"object_type": {
"description": "Integration-delivery filter.",
"type": "string"
},
"operation": {
"description": "Integration-delivery filter.",
"type": "string"
},
"outcome": {
"description": "Integration-delivery filter.",
"enum": [
"success",
"failure"
],
"type": "string"
},
"provider": {
"description": "Integration-delivery filter.",
"type": "string"
},
"severity": {
"description": "Runtime-event filter.",
"enum": [
"info",
"warning",
"error"
],
"type": "string"
},
"source": {
"description": "Event stream to read (default: all).",
"enum": [
"all",
"runtime",
"delivery"
],
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"name": "list_observability_events",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"events": {
"items": {
"type": "object"
},
"type": "array"
},
"pagination": {
"properties": {
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"next_cursor": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the per-period overage-minutes ledger (older per-minute-overage plans only; current plans carry no overage). GET /v1/balance/get_balance only returns an aggregate; this returns the underlying per-period ledger rows.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"status": {
"enum": [
"pending",
"synced",
"skipped",
"error"
],
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"name": "list_overage_charges",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"charges": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read the canonical public KaiCalls plan catalog, monthly USD prices and allowances. Does not select a plan, create checkout, or change billing.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "list_plans",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"plans": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List a business's agent product catalog.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"category": {
"description": "Filter by category (optional).",
"type": "string"
},
"inventory": {
"description": "Include current inventory quantity per product (optional).",
"type": "boolean"
},
"query": {
"description": "Free-text search over name/description (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "list_products",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"products": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List and search the business's calls, newest first, each with who called (when known) and a short summary of what they wanted. Search by caller phone, by words in the call summary (\"water heater\", \"quote\"), and by date window; filters combine. Use get_transcript for the full call.",
"inputSchema": {
"properties": {
"after": {
"description": "Only items at or after this ISO-8601 date or time (optional).",
"type": "string"
},
"agent_id": {
"description": "Filter by agent ID (optional)",
"type": "string"
},
"before": {
"description": "Only items before this ISO-8601 date or time (optional).",
"type": "string"
},
"limit": {
"description": "Max results to return (default 20, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
},
"phone": {
"description": "Only this caller: any phone format; matches on the last 10 digits (optional).",
"type": "string"
},
"query": {
"description": "Words to find in the call summary, e.g. \"water heater\" (optional).",
"type": "string"
},
"status": {
"description": "Filter by status (optional)",
"type": "string"
}
},
"type": "object"
},
"name": "list_recent_calls",
"outputSchema": {
"additionalProperties": true,
"properties": {
"calls": {
"items": {
"type": "object"
},
"type": "array"
},
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filters": {
"type": "object"
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List per-period automatic plan right-size decisions, including the dry_run -> notified -> (kept | applied | superseded) lifecycle. Answers \"is this business about to get right-sized\".",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"none",
"upgrade",
"downgrade",
"handoff_custom"
],
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"status": {
"enum": [
"dry_run",
"notified",
"kept",
"applied",
"superseded"
],
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"name": "list_rightsize_recommendations",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"recommendations": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Read SMS and WhatsApp message evidence for accessible businesses (sms:read), including provider message ID, carrier status, delivery/failure timestamps and failure code. Filter by business_id, conversation or direction, and search by phone number (either side), words in the message, and date window. Provider acceptance is not delivery; delivered_at and carrier status record delivery. Uses offset pagination.",
"inputSchema": {
"properties": {
"after": {
"description": "Only items at or after this ISO-8601 date or time (optional).",
"type": "string"
},
"before": {
"description": "Only items before this ISO-8601 date or time (optional).",
"type": "string"
},
"business_id": {
"description": "Narrow to one accessible business (optional).",
"type": "string"
},
"conversation_id": {
"description": "Filter by conversation ID (optional)",
"type": "string"
},
"direction": {
"description": "Filter by direction: inbound or outbound (optional)",
"type": "string"
},
"limit": {
"description": "Max results to return (default 50, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
},
"phone": {
"description": "Only this caller: any phone format; matches on the last 10 digits (optional).",
"type": "string"
},
"query": {
"description": "Words to find in the message text (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "list_sms_messages",
"outputSchema": {
"additionalProperties": true,
"properties": {
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filters": {
"type": "object"
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"messages": {
"items": {
"type": "object"
},
"type": "array"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the business plan and price changes, newest first: upgrades, downgrades, add-ons and automatic right-size moves.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"change_type": {
"enum": [
"plan_change",
"created",
"canceled",
"reactivated",
"rightsize"
],
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"source": {
"description": "e.g. stripe_webhook, rightsize_apply_job.",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"name": "list_subscription_history",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"changes": {
"items": {
"type": "object"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List per-call voice-agent tool execution traces — outcome, latency, timeout, and a redacted result preview for each routed tool call. Answers \"did this tool call actually work\".",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"call_id": {
"description": "Call/conversation id filter.",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"limit": {
"default": 50,
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"outcome_status": {
"description": "Outcome envelope status filter (e.g. success, needs_clarification, unavailable, queued, retryable_delay, hard_failure).",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
},
"tool_call_id": {
"description": "Exact tool_call_id filter.",
"type": "string"
},
"tool_name": {
"description": "Tool name filter (e.g. send_sms).",
"type": "string"
}
},
"type": "object"
},
"name": "list_tool_execution_logs",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"logs": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List recent voicemails for the authenticated business, including transcripts and recording URLs.",
"inputSchema": {
"properties": {
"limit": {
"description": "Max results to return (default 20, max 100)",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"offset": {
"description": "Zero-based pagination offset (default 0)",
"minimum": 0,
"type": "integer"
}
},
"type": "object"
},
"name": "list_voicemails",
"outputSchema": {
"additionalProperties": true,
"properties": {
"count": {
"type": "integer"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"has_more": {
"type": "boolean"
},
"limit": {
"type": "integer"
},
"next_offset": {
"type": [
"integer",
"null"
]
},
"offset": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"voicemails": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the curated, credential-free voice catalog (id, display name, accent, language, gender, sample URL) used to configure agent voices.",
"inputSchema": {
"properties": {
"gender": {
"description": "Filter by gender: male or female.",
"type": "string"
},
"language": {
"description": "Filter by language label, e.g. English or Spanish.",
"type": "string"
},
"provider": {
"description": "Filter by a voice provider id exactly as list_voices returns it.",
"type": "string"
}
},
"type": "object"
},
"name": "list_voices",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"voices": {
"items": {
"type": "object"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "List the cadence/campaign workflow templates KaiCalls can run (standard, aggressive, nurture, custom), including each template's retry interval, defaults (call windows, days, attempts), and a ready-to-use cadence_config example. The cadence_config examples match the shape create_campaign accepts, including multi-step sequences with launch=true. Static catalog — no per-business state.",
"inputSchema": {
"properties": {},
"type": "object"
},
"name": "list_workflow_templates",
"outputSchema": {
"additionalProperties": true,
"properties": {
"cadence_config_fields": {
"items": {
"type": "object"
},
"type": "array"
},
"defaults": {
"type": "object"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"templates": {
"items": {
"type": "object"
},
"type": "array"
},
"usage": {
"type": "string"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Place an outbound call through a KaiCalls AI agent: call back a customer who previously called this business, give the owner a voice preview, or call on the owner's behalf (a landlord, clinic, pharmacy, school or utility) with the task in context. For a customer callback, pass the existing lead_id and callback goal in context. Kai verifies the business's inbound-call consent for the exact destination; a verified callback can go directly to a cell phone without connecting the owner. Contact existence alone is not callback permission, and opt-outs still block calls. A call never proves inbound routing or advances activation. report_language sets the language the result is reported in, and Kai then confirms exact details for that reader; Kai speaks call_language (English by default) on the phone. A new account's first call to a US or Canada business line is free; after that the account needs a plan. Kai calls businesses, not personal cell phones, on a free call. For a business that answers on a cell phone, connect_me has Kai ring the person's own saved phone and connect them, so they do the talking. While the call runs, check_call_status shows its live_transcript and send_call_note steers Kai. hold_for_me has Kai wait on hold at a business and connect the person when someone answers. An idempotency_key makes the request safely retryable. Only `to` is required: with no agent_id the account's one agent places the call.",
"inputSchema": {
"properties": {
"agent_id": {
"description": "KaiCalls agent ID to use for the call (optional). Leave it out when the account has one agent: Kai uses that one. With several agents and none named, no call is placed and the answer lists them",
"type": "string"
},
"call_language": {
"description": "Language Kai speaks on the call (optional, default en)",
"enum": [
"en",
"es"
],
"type": "string"
},
"caller_id": {
"description": "Which number the other side sees (optional). 'own' shows the person's own verified number (start_own_caller_id) so they recognize who is calling; with none verified, no call is placed. 'business_line' shows the KaiCalls line. Left out, the account's saved choice applies. A free first call always shows the KaiCalls line",
"enum": [
"own",
"business_line"
],
"type": "string"
},
"connect_me": {
"description": "True when the person wants to talk to `to` themselves, for example a business that answers on a cell phone: Kai rings the person's own phone saved on the account (set_owner_phone), says one line and connects them to `to`. Kai never speaks to `to`. Takes no lead_id and cannot be listen-only (optional)",
"type": "boolean"
},
"connector_activation_call": {
"description": "True only for the one-time connector activation call the recipient explicitly requested in this conversation. This is not permission for marketing, SMS, or future calls.",
"type": "boolean"
},
"context": {
"description": "Call context or reason (optional)",
"type": "string"
},
"external_ref": {
"description": "Your own reference for the conversation or task this call belongs to (up to 200 characters, optional). It comes back unchanged on check_call_status and on every webhook event for this call (call.question_pending, call.completed), so your agent can return the result to the right conversation.",
"maxLength": 200,
"type": "string"
},
"first_message": {
"description": "Override the agent greeting message (optional)",
"type": "string"
},
"hold_for_me": {
"description": "True when the person wants Kai to wait on hold for them: Kai calls `to`, gets through the phone menu and hold queue, and the moment a live person answers, says one line and connects the person's own phone saved on the account (set_owner_phone) so they do the talking. If they don't pick up, Kai does the task in context itself. Needs a saved phone and a plan (not on the free first call). Takes no lead_id and cannot be listen-only or connect_me (optional)",
"type": "boolean"
},
"idempotency_key": {
"description": "Client-chosen key that makes this call exactly-once: retries with the same key never place a second call (optional but recommended)",
"type": "string"
},
"lead_id": {
"description": "Existing lead ID to associate (optional)",
"type": "string"
},
"listen_only": {
"description": "True to only listen: Kai calls a business, stays silent, records what answers (voicemail, answering service, phone menu or no answer) and hangs up within about 75 seconds without leaving a message. Takes no lead_id; context is ignored (optional)",
"type": "boolean"
},
"name": {
"description": "Caller/lead name (optional)",
"type": "string"
},
"report_language": {
"description": "Language the person asking reads, as a code or name (e.g. ar, ht, tr, bn, es, zh, vi). Kai confirms names, dates and numbers so the result can be relayed in this language (optional)",
"type": "string"
},
"to": {
"description": "Phone number to call (E.164 format, e.g. +19085551234)",
"type": "string"
}
},
"required": [
"to"
],
"type": "object"
},
"name": "make_call",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call": {
"properties": {
"agent_id": {
"type": "string"
},
"business_id": {
"type": "string"
},
"conversation_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"lead_id": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"to": {
"type": "string"
}
},
"type": "object"
},
"call_language": {
"type": "string"
},
"counts_toward_activation": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"external_ref": {
"type": [
"string",
"null"
]
},
"idempotency_key": {
"type": "string"
},
"intent_id": {
"type": "string"
},
"preview_only": {
"type": "boolean"
},
"replayed": {
"type": "boolean"
},
"report_language": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Connect CallRail call tracking to a business's line. Order: (1) connect {api_key, account_id?}; (2) get_callrail status lists the companies the key can see; (3) link_company {company_id, target_business_id?} once per business; (4) set_writeback {enabled}; (5) get_callrail list_trackers; (6) route_tracker only after the owner says yes. The API key: the person may paste their CallRail API v3 key straight into this chat. Take it and pass it as api_key; do not send them elsewhere to paste it. KaiCalls stores it encrypted and never returns it. One agency-level key serves every company that CallRail login can see, so connect once and link each firm with its own link_company. They create the key in CallRail under Integrations > API Keys > Create API V3 Key, signed in as a login that can see every company to link. CallRail shows the key only once. If they would rather paste it themselves: https://www.kaicalls.com/dashboard/settings/connections?connector=callrail. If connect answers choose_account, call it again with one of the returned account ids. link_company subscribes that CallRail company's calls: calls Kai answers get the CallRail source, campaign, keyword and landing page, and Kai's outcome is written back to CallRail as a KaiCalls tag, a summary note and good_lead when Kai qualified the caller. route_tracker {link_id, tracker_id, mode} changes where a live tracking number rings: mode kai_answers sends every call to Kai; business_first sends it to a KaiCalls line that rings the owner first so Kai takes only the misses. restore_tracker puts the earlier destination back. Leaving numbers unrouted is tracking-only. unlink_company {link_id}; disconnect. Requires current admin role on every business involved. Changing a tracker changes a live phone line: confirm with the owner first.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"account_id": {
"description": "Only when connect answered choose_account: one of the account ids it listed.",
"type": "string"
},
"action": {
"enum": [
"connect",
"link_company",
"unlink_company",
"route_tracker",
"restore_tracker",
"set_writeback",
"disconnect"
],
"type": "string"
},
"api_key": {
"description": "CallRail API v3 key, as the person pasted it in chat. Stored encrypted; never returned.",
"maxLength": 200,
"type": "string"
},
"business_id": {
"format": "uuid",
"type": "string"
},
"company_id": {
"description": "A company id from get_callrail status (companies[].id).",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"kai_number": {
"type": "string"
},
"link_id": {
"format": "uuid",
"type": "string"
},
"mode": {
"enum": [
"kai_answers",
"business_first"
],
"type": "string"
},
"target_business_id": {
"format": "uuid",
"type": "string"
},
"tracker_id": {
"type": "string"
}
},
"required": [
"business_id",
"action"
],
"type": "object"
},
"name": "manage_callrail",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Connect Nimbata call tracking to a business's line. connect {api_token} checks and saves a Nimbata personal API token (Agency plan; one token can serve many businesses). link_project {project_id, target_business_id?} attaches that Nimbata project's calls to a business and adds KaiCalls tags to the project: calls Kai answers get Nimbata's source, UTM and click ids, and Kai's outcome is written back to the Nimbata call as a KaiCalls tag, a KaiCalls qualified tag when Kai qualified the caller, and a summary comment. unlink_project {link_id}; set_writeback {enabled}; disconnect. Requires current admin role on every business involved. Routing stays in Nimbata: add the KaiCalls number to the project's call flow there.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"connect",
"link_project",
"unlink_project",
"set_writeback",
"disconnect"
],
"type": "string"
},
"api_token": {
"maxLength": 4096,
"type": "string"
},
"business_id": {
"format": "uuid",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"link_id": {
"format": "uuid",
"type": "string"
},
"project_id": {
"type": "string"
},
"target_business_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id",
"action"
],
"type": "object"
},
"name": "manage_nimbata",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Pause an outbound call campaign. Stops its queued and scheduled calls and cancels pending call attempts; a call already in progress may finish. Leads are kept and the campaign can be resumed later with launch_call_campaign. Needs campaign_id, the calls:write scope and an admin role in the business. Pausing an already paused campaign changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"campaign_id": {
"description": "The call campaign, from list_campaigns.",
"type": "string"
}
},
"required": [
"campaign_id"
],
"type": "object"
},
"name": "pause_call_campaign",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"cancelled_attempts": {
"type": [
"integer",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"paused_jobs": {
"type": [
"integer",
"null"
]
},
"queued": {
"type": [
"integer",
"null"
]
},
"reset_leads": {
"type": [
"integer",
"null"
]
},
"sequence_id": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Submit an authorized, truthful Google LSA quality survey and return Google's actual bonus-credit decision. This is not a guaranteed refund or the retired manual dispute workflow. Requires admin role and a stable retry key. Each rating is a per-lead survey answer based on that lead, not a bulk dissatisfaction claim. The reason must match the positive/negative rating; OTHER requires a comment. Neutral takes no reason.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"comment": {
"maxLength": 1000,
"type": "string"
},
"idempotency_key": {
"maxLength": 150,
"minLength": 1,
"type": "string"
},
"lead_id": {
"format": "uuid",
"type": "string"
},
"rating": {
"enum": [
"VERY_SATISFIED",
"SATISFIED",
"NEUTRAL",
"DISSATISFIED",
"VERY_DISSATISFIED"
],
"type": "string"
},
"reason": {
"enum": [
"BOOKED_CUSTOMER",
"LIKELY_BOOKED_CUSTOMER",
"SERVICE_RELATED",
"HIGH_VALUE_SERVICE",
"OTHER_SATISFIED_REASON",
"GEO_MISMATCH",
"JOB_TYPE_MISMATCH",
"NOT_READY_TO_BOOK",
"SPAM",
"DUPLICATE",
"SOLICITATION",
"OTHER_DISSATISFIED_REASON"
],
"type": "string"
}
},
"required": [
"business_id",
"lead_id",
"rating",
"idempotency_key"
],
"type": "object"
},
"name": "rate_lsa_lead",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Recompute one business's KaiCalls trust level now from its live account activity (card on file, paid bills, days active, real customer calls) and save the result, the same recheck the dashboard runs, for example right after the owner adds a card. Returns the same view as get_trust_level plus whether the level moved up or down. Requires current business membership. Replaces the saved derived state, may record level-change history and may email the current owner when standing changes. It can only reflect what the account has earned; it never sets or raises a level by request.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token reaches exactly one business).",
"type": "string"
},
"focus": {
"description": "'standing' (default): the current level and next steps. 'ladder': every level. 'level': the one named in level. 'outbound': today's outbound calls and texts against the limits this level allows, and the step that raises them.",
"enum": [
"standing",
"ladder",
"level",
"outbound"
],
"type": "string"
},
"level": {
"description": "A level key or name, e.g. 'pro'. Used with focus 'level'.",
"type": "string"
}
},
"type": "object"
},
"name": "recheck_trust_level",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"computed_at": {
"type": "string"
},
"detail": {
"type": [
"object",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"held": {
"type": [
"string",
"null"
]
},
"ladder": {
"items": {
"type": "object"
},
"type": "array"
},
"level": {
"type": "object"
},
"line": {
"type": "string"
},
"meters": {
"items": {
"type": "object"
},
"type": "array"
},
"moved": {
"enum": [
"up",
"down",
null
],
"type": [
"string",
"null"
]
},
"next": {
"type": [
"object",
"null"
]
},
"next_opens_later": {
"type": "boolean"
},
"previous_level": {
"type": [
"string",
"null"
]
},
"progress": {
"type": "number"
},
"quests": {
"items": {
"type": "object"
},
"type": "array"
},
"rechecked": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Record that existing customers gave the business permission to email them, with evidence_ref saying where that permission came from. Pass lead_id and email for one customer, or emails for up to 200. Addresses that are not existing customers are skipped and listed. Sends no email. Needs an admin of the business. Each record states that the owner holds that permission.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"email": {
"description": "That customer's email address.",
"type": "string"
},
"emails": {
"description": "Email addresses of existing customers, up to 200, as an alternative to lead_id.",
"items": {
"type": "string"
},
"maxItems": 200,
"type": "array"
},
"evidence_ref": {
"description": "Where the permission came from or why it is withdrawn, e.g. 'web form opt-in' or 'customer asked to stop'.",
"type": "string"
},
"expires_at": {
"description": "Optional: when the permission ends (ISO date).",
"type": "string"
},
"lead_id": {
"description": "One existing customer (lead id), paired with email.",
"type": "string"
}
},
"required": [
"business_id",
"evidence_ref"
],
"type": "object"
},
"name": "record_email_consent",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Stop showing the person's own number on Kai's calls; calls show the KaiCalls line again. Business owner only.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
}
},
"type": "object"
},
"name": "remove_own_caller_id",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"removed": {
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Report a problem with your KaiCalls agent, phone number, billing, or account. Saves the report to your change history and notifies KaiCalls support so a person can follow up on anything broken or not working as expected.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"category": {
"default": "other",
"description": "What part of the product this issue relates to.",
"enum": [
"agent_behavior",
"call_quality",
"billing",
"integration",
"phone_number",
"other"
],
"type": "string"
},
"description": {
"description": "Full details: what happened, what you expected, and any relevant call or time.",
"type": "string"
},
"reporter_email": {
"description": "Email address support should reply to, if different from the account email.",
"type": "string"
},
"severity": {
"default": "medium",
"description": "How badly this is affecting the business.",
"enum": [
"low",
"medium",
"high",
"urgent"
],
"type": "string"
},
"summary": {
"description": "One-line summary of the problem (max 200 characters).",
"type": "string"
}
},
"required": [
"summary",
"description"
],
"type": "object"
},
"name": "report_issue",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"category": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"report_id": {
"type": "string"
},
"severity": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"support_notified": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Change a live agent's name, greeting, prompts, voice, model, call length or call transfer through the approval-gated path, for changes made on the owner's behalf that need a recorded approval. Needs agent_id, at least one field to change and the owner's confirmed approval. Callers hear the change on their next call. Direct edits by the owner go through update_agent_config. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "The agent to change.",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"properties": {
"confirmation_ref": {
"type": "string"
},
"confirmed_at": {
"type": "string"
},
"confirmed_by": {
"type": "string"
},
"mode": {
"enum": [
"none",
"agent_asserted",
"human_confirmed",
"dashboard_session",
"system_policy"
],
"type": "string"
}
},
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"dry_run": {
"description": "Check access, inputs and approval without making the change.",
"type": "boolean"
},
"extraction_schema": {
"description": "Fields to capture from each call.",
"type": "object"
},
"first_message": {
"description": "The greeting callers hear.",
"type": "string"
},
"idempotency_key": {
"description": "Required to make the change. Repeating a key returns the first outcome instead of running the change again.",
"type": "string"
},
"inbound_prompt": {
"description": "Instructions for incoming calls.",
"type": "string"
},
"max_duration": {
"description": "Longest call length, in seconds.",
"type": "number"
},
"metadata": {
"description": "Agent metadata to merge.",
"type": "object"
},
"model": {
"description": "Language model settings: { provider, model }.",
"type": "object"
},
"name": {
"description": "The name the agent uses.",
"type": "string"
},
"outbound_first_message": {
"description": "Opening line on outgoing calls.",
"type": "string"
},
"outbound_llm": {
"description": "Model for outgoing calls.",
"type": "string"
},
"outbound_prompt": {
"description": "Instructions for outgoing calls.",
"type": "string"
},
"queue_for_approval": {
"description": "When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why the change is being made; kept in the audit log.",
"type": "string"
},
"sms_llm": {
"description": "Model for text replies.",
"type": "string"
},
"sms_prompt": {
"description": "Instructions for text replies.",
"type": "string"
},
"source_ref": {
"description": "Optional reference for the request, such as a ticket or automation run ID.",
"type": "string"
},
"transfer_enabled": {
"description": "Whether the agent may transfer calls to a person.",
"type": "boolean"
},
"transfer_phone_number": {
"description": "Where transfers go (E.164).",
"type": "string"
},
"voice": {
"description": "Voice to use, from list_voices: { provider, voiceId }.",
"type": "object"
},
"voice_catalog_id": {
"description": "Voice to use: an id from list_voices. Preferred over voice.",
"type": "string"
}
},
"required": [
"agent_id",
"idempotency_key"
],
"type": "object"
},
"name": "request_agent_update",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"intent": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"missing_fields": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Put a live agent back on a saved earlier version of its configuration (listed by list_config_versions), with the owner's confirmed approval. Replaces the current live configuration; callers hear the restored version on their next call. Needs agent_id and version_number or version_id. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "The agent to roll back.",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"properties": {
"confirmation_ref": {
"type": "string"
},
"confirmed_at": {
"type": "string"
},
"confirmed_by": {
"type": "string"
},
"mode": {
"enum": [
"none",
"agent_asserted",
"human_confirmed",
"dashboard_session",
"system_policy"
],
"type": "string"
}
},
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"dry_run": {
"description": "Check access, inputs and approval without making the change.",
"type": "boolean"
},
"idempotency_key": {
"description": "Required to make the change. Repeating a key returns the first outcome instead of running the change again.",
"type": "string"
},
"queue_for_approval": {
"description": "When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why the change is being made; kept in the audit log.",
"type": "string"
},
"source_ref": {
"description": "Optional reference for the request, such as a ticket or automation run ID.",
"type": "string"
},
"version_id": {
"description": "Or the saved version id.",
"type": "string"
},
"version_number": {
"description": "The saved version to restore.",
"type": "integer"
}
},
"required": [
"agent_id",
"idempotency_key"
],
"type": "object"
},
"name": "request_config_rollback",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"intent": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"missing_fields": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Set up a sending address for a business's email campaigns on a domain the business controls (for example mail.example.com). Registers the domain with the email delivery provider and returns the DNS records the owner must add where the domain is hosted. May replace an existing reply address, enabled state and sending limit, and may provision provider inbound routing, inbox and webhook. Sends no email. The sender becomes ready on its own once the records verify; check_email_sender re-checks now. Needs an admin of the business. Campaign email only goes from the business’s own verified sending domain, to customers with recorded email permission who are not on the do-not-email list, within the daily amount the business’s Kai level allows.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"domain": {
"description": "The sending domain, e.g. mail.example.com.",
"type": "string"
},
"from": {
"description": "The From address on that domain.",
"type": "string"
},
"reply_to": {
"description": "Where customer replies go. Must also be an address on that domain.",
"type": "string"
}
},
"required": [
"business_id",
"domain",
"from",
"reply_to"
],
"type": "object"
},
"name": "request_email_sender",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Set the emergency (E911) service address for one of the business's phone numbers with the phone carrier, so a 911 call from that line reaches the right dispatcher. Needs phone_number, the full street address and disclosure_acknowledged true after the owner reads the 911 notice, plus the owner's confirmed approval. Replaces any address on file for that number. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"address": {
"description": "Where the phone is used.",
"properties": {
"city": {
"type": "string"
},
"customerName": {
"description": "Business or person at the address.",
"type": "string"
},
"isoCountry": {
"description": "Default 'US'.",
"type": "string"
},
"postalCode": {
"type": "string"
},
"region": {
"description": "Two-letter state code.",
"type": "string"
},
"street": {
"type": "string"
}
},
"required": [
"customerName",
"street",
"city",
"region",
"postalCode"
],
"type": "object"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"properties": {
"confirmation_ref": {
"type": "string"
},
"confirmed_at": {
"type": "string"
},
"confirmed_by": {
"type": "string"
},
"mode": {
"enum": [
"none",
"agent_asserted",
"human_confirmed",
"dashboard_session",
"system_policy"
],
"type": "string"
}
},
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"disclosure_acknowledged": {
"description": "True only after the owner has read and accepted the 911 service notice.",
"type": "boolean"
},
"dry_run": {
"description": "Check access, inputs and approval without making the change.",
"type": "boolean"
},
"idempotency_key": {
"description": "Required to make the change. Repeating a key returns the first outcome instead of running the change again.",
"type": "string"
},
"phone_number": {
"description": "The business line, in E.164 format.",
"type": "string"
},
"queue_for_approval": {
"description": "When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why the change is being made; kept in the audit log.",
"type": "string"
},
"source_ref": {
"description": "Optional reference for the request, such as a ticket or automation run ID.",
"type": "string"
}
},
"required": [
"phone_number",
"address",
"disclosure_acknowledged",
"idempotency_key"
],
"type": "object"
},
"name": "request_emergency_address",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"intent": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"missing_fields": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Reserve an exact pool number and request an owner-only browser review of its recurring extra-line price. Requires numbers:write and billing:write. It never charges included or prepaid capacity; included allocation goes through attach_number. This tool does not approve payment or prove activation.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"agent_id": {
"type": "string"
},
"business_id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
},
"phone_number": {
"type": "string"
}
},
"required": [
"business_id",
"agent_id",
"phone_number",
"idempotency_key"
],
"type": "object"
},
"name": "request_extra_number",
"outputSchema": null
},
{
"description": "Ask a named principal for a specific decision using the provisioned voice approval channel. Requires restricted approvals:write, a configured callback host and signing secret. Returns dispatch status; the signed callback carries the decision and evidence. No approval is implied by dispatch. SMS-only delivery is unavailable.",
"inputSchema": {
"$id": "https://www.kaicalls.com/api/v1/schemas/approvalRequestCreate",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Generic, provider-neutral approval-channel intake — lets an external agent control plane (first consumer: Zehrava Gate) reach a human by voice and get the interaction tracked through the normal call lifecycle.",
"properties": {
"callback_secret_id": {
"type": "string"
},
"callback_url": {
"description": "Must be https and host-allowlisted.",
"format": "uri",
"type": "string"
},
"channel": {
"additionalProperties": false,
"properties": {
"address": {
"description": "E.164 phone number.",
"type": "string"
},
"type": {
"description": "Only voice-prefixed types dispatch a live call today; \"sms\" returns 501.",
"enum": [
"voice",
"voice_then_sms",
"sms_then_voice",
"sms"
],
"type": "string"
}
},
"required": [
"type",
"address"
],
"type": "object"
},
"expires_at": {
"format": "date-time",
"type": "string"
},
"message_id": {
"type": "string"
},
"principal_id": {
"type": "string"
},
"required_factors": {
"items": {
"type": "string"
},
"type": "array"
},
"responds_to_hash": {
"pattern": "^sha256:[a-f0-9]{64}$",
"type": "string"
},
"risk_level": {
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string"
},
"source": {
"description": "Lowercase control-plane slug, e.g. \"zehrava-gate\".",
"type": "string"
},
"source_intent_id": {
"type": "string"
},
"source_request_id": {
"type": "string"
},
"summary": {
"maxLength": 2000,
"type": "string"
}
},
"required": [
"source",
"source_request_id",
"principal_id",
"channel",
"summary",
"risk_level",
"expires_at",
"callback_url"
],
"title": "Approval Channel Request Create",
"type": "object"
},
"name": "request_human_approval",
"outputSchema": null
},
{
"description": "Buy a specific available phone number for the business from the phone carrier, with the owner's confirmed approval. The carrier bills the number to the business right away. Available numbers come from search_available_numbers. Optionally connects it to agent_id. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "Optional: the agent that answers the number.",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"properties": {
"confirmation_ref": {
"type": "string"
},
"confirmed_at": {
"type": "string"
},
"confirmed_by": {
"type": "string"
},
"mode": {
"enum": [
"none",
"agent_asserted",
"human_confirmed",
"dashboard_session",
"system_policy"
],
"type": "string"
}
},
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"dry_run": {
"description": "Check access, inputs and approval without making the change.",
"type": "boolean"
},
"idempotency_key": {
"description": "Required to make the change. Repeating a key returns the first outcome instead of running the change again.",
"type": "string"
},
"phone_number": {
"description": "The number to buy (E.164), from search_available_numbers.",
"type": "string"
},
"queue_for_approval": {
"description": "When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why the change is being made; kept in the audit log.",
"type": "string"
},
"source_ref": {
"description": "Optional reference for the request, such as a ticket or automation run ID.",
"type": "string"
}
},
"required": [
"phone_number",
"idempotency_key"
],
"type": "object"
},
"name": "request_number_purchase",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"intent": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"missing_fields": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create or update a webhook that receives the business's completed-call events (which can include transcripts) at a URL the business controls. Needs webhook_url and the owner's confirmed approval because call data leaves KaiCalls. A new webhook's signing secret is returned once. Returns needs_user_input, needs_approval, pending_approval, executed, denied or unsupported; only executed means the change was made.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"properties": {
"confirmation_ref": {
"type": "string"
},
"confirmed_at": {
"type": "string"
},
"confirmed_by": {
"type": "string"
},
"mode": {
"enum": [
"none",
"agent_asserted",
"human_confirmed",
"dashboard_session",
"system_policy"
],
"type": "string"
}
},
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the token can reach more than one business.",
"type": "string"
},
"description": {
"description": "Optional label for the webhook.",
"type": "string"
},
"dry_run": {
"description": "Check access, inputs and approval without making the change.",
"type": "boolean"
},
"events": {
"description": "Events to send. Default ['call.completed'].",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Optional: an existing webhook to update.",
"type": "string"
},
"idempotency_key": {
"description": "Required to make the change. Repeating a key returns the first outcome instead of running the change again.",
"type": "string"
},
"is_active": {
"description": "Optional: false to save it switched off.",
"type": "boolean"
},
"queue_for_approval": {
"description": "When approval is missing, create a pending approval the owner can accept in the dashboard instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why the change is being made; kept in the audit log.",
"type": "string"
},
"source_ref": {
"description": "Optional reference for the request, such as a ticket or automation run ID.",
"type": "string"
},
"webhook_url": {
"description": "HTTPS URL that receives the events.",
"type": "string"
}
},
"required": [
"webhook_url",
"idempotency_key"
],
"type": "object"
},
"name": "request_transcript_webhook",
"outputSchema": {
"additionalProperties": true,
"properties": {
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"intent": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"missing_fields": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "APPROVAL-GATED. Send the owner's activation notification again, as a real text or email through KaiCalls' messaging provider, for the exact active activation session. Only retries a channel whose last attempt failed or has waited long enough; an attempt whose outcome is unknown is never blindly resent. Requires a new idempotency_key.",
"inputSchema": {
"properties": {
"activation_session_id": {
"type": "string"
},
"authority": {
"type": "object"
},
"business_id": {
"type": "string"
},
"channel": {
"enum": [
"sms",
"email"
],
"type": "string"
},
"idempotency_key": {
"type": "string"
}
},
"required": [
"business_id",
"activation_session_id",
"channel",
"idempotency_key"
],
"type": "object"
},
"name": "retry_activation_notification",
"outputSchema": {
"additionalProperties": true,
"properties": {
"activation_session_id": {
"type": "string"
},
"attempt": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Reconcile database pointers for an existing imported signup phone reservation. Owner-only, entitlement-checked, single-flight and idempotent. Never creates agents, buys numbers, changes provider routing or sends messages. PBX, missing imports, and stale claims return review blockers. Reusing the same key reads or replays the outcome; a failed request is held for review before a new key is accepted. Ready means database agreement, not activation.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"agent_id": {
"type": "string"
},
"business_id": {
"type": "string"
},
"idempotency_key": {
"type": "string"
}
},
"required": [
"business_id",
"agent_id",
"idempotency_key"
],
"type": "object"
},
"name": "retry_setup",
"outputSchema": null
},
{
"description": "Take back email permission for existing customers so no campaign can email them. Pass lead_id and email for one customer, or emails for up to 200, with evidence_ref saying why. Needs an admin of the business.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The business that sends the email.",
"type": "string"
},
"email": {
"description": "That customer's email address.",
"type": "string"
},
"emails": {
"description": "Email addresses of existing customers, up to 200, as an alternative to lead_id.",
"items": {
"type": "string"
},
"maxItems": 200,
"type": "array"
},
"evidence_ref": {
"description": "Where the permission came from or why it is withdrawn, e.g. 'web form opt-in' or 'customer asked to stop'.",
"type": "string"
},
"lead_id": {
"description": "One existing customer (lead id), paired with email.",
"type": "string"
}
},
"required": [
"business_id",
"evidence_ref"
],
"type": "object"
},
"name": "revoke_email_consent",
"outputSchema": {
"additionalProperties": true,
"properties": {
"action": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"fingerprint": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"senderId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Request a rollback to a saved version of the agent settings. It restores the version's greeting, voice, prompt (and the editable prompt copy, when the version saved one), model and call summary/scoring. Transfer settings, call length, tools and speech recognition stay as they are; the result lists what was and was not restored. When the business owner or an admin is signed in through this connector, the rollback applies immediately; otherwise the owner approves it from a review link. Targets are listed by list_config_versions. The rollback is itself saved as a new version, and secrets are never copied.",
"inputSchema": {
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "Agent ID to roll back.",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"type": "object"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"dry_run": {
"description": "Validate tenant, scope, and policy without touching the live config.",
"type": "boolean"
},
"idempotency_key": {
"description": "Stable key for this rollback; repeating it returns the first outcome. Defaults to a key from the agent, the target version and the version live now, so rolling back to the same version again after later changes works. The result returns the key used.",
"type": "string"
},
"queue_for_approval": {
"description": "Create a durable owner-review request (default true). Setting false returns needs_approval, but an authority-envelope retry still cannot execute.",
"type": "boolean"
},
"reason": {
"description": "Optional human-readable reason recorded in the audit trail.",
"type": "string"
},
"source_ref": {
"description": "External source reference, such as a ticket or automation run ID.",
"type": "string"
},
"version_id": {
"description": "Version id to restore, from list_config_versions. One of version_number/version_id is required.",
"type": "string"
},
"version_number": {
"description": "Version number to restore, from list_config_versions. One of version_number/version_id is required.",
"type": "integer"
}
},
"required": [
"agent_id"
],
"type": "object"
},
"name": "rollback_config",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_id": {
"type": "string"
},
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"idempotency_key": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"description": "On executed: { agent_id, restored_from_version, restored_fields, skipped_fields, not_restored, new_version_number, warning? }.",
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Run a saved test scenario against one of the business's agents and grade the agent's replies: pass eval_id for one scenario, or agent_id for every scenario saved for that agent (see list_evals). The test is a simulated text conversation with the agent's current live configuration; no phone call is placed, no customer is contacted and the agent's configuration is not changed. Each run uses paid voice-agent provider capacity and is recorded with its result, so scenarios already run on the agent's current configuration are not run again unless force is true, and each agent has a daily limit on runs. Returns pass or fail per scenario with the grader's reasons.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"agent_id": {
"description": "Run every saved scenario for this agent. Either this or eval_id is required.",
"type": "string"
},
"eval_id": {
"description": "Run this one saved scenario (from list_evals). Either this or agent_id is required.",
"type": "string"
},
"force": {
"description": "Run again even though nothing changed on the agent or these scenarios since they last ran (otherwise refused, since the result would be the same).",
"type": "boolean"
},
"max_wait_ms": {
"description": "Per-run wait cap in ms when wait is true (default 60000, max 110000).",
"type": "integer"
},
"wait": {
"description": "Wait for the grade before returning (default true).",
"type": "boolean"
}
},
"type": "object"
},
"name": "run_eval",
"outputSchema": {
"additionalProperties": true,
"properties": {
"completed": {
"type": [
"integer",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"failed": {
"type": [
"integer",
"null"
]
},
"passed": {
"type": [
"boolean",
"null"
]
},
"provider_run_id": {
"type": [
"string",
"null"
]
},
"results": {
"type": [
"array",
"object",
"null"
]
},
"run_id": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"total": {
"type": [
"integer",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Save a business's legal name, the name customers know it by (if different), entity type, industry, website, address, authorized contact and what it will text (service only, or service and sales) for its own carrier registration. Business owner, or an admin of the business (such as the partner that created the workspace) preparing it for the owner. Each field holds an answer from the owner; anything omitted is filled from what is already on file (see get_text_registration `known`). Answers can be saved one at a time: answers given so far are kept, and while questions remain the result lists `saved_steps`, `missing` and `next_question`. The owner can finish here or on the registration page. Never takes the EIN: the owner types it on the registration page returned as setup_url. Each saved answer replaces the value on file for that field. Refused once a filing is already with the carriers. Charges nothing and files nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"brand_name": {
"description": "Optional: the name customers know the business by, when it differs from the legal name (a DBA or trade name, as shown on its website). Texts are signed with it.",
"type": "string"
},
"business_id": {
"type": "string"
},
"business_type": {
"enum": [
"Sole Proprietorship",
"Partnership",
"Limited Liability Corporation",
"Co-operative",
"Non-profit Corporation",
"Corporation"
],
"type": "string"
},
"city": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_first_name": {
"type": "string"
},
"contact_job_position": {
"enum": [
"Director",
"GM",
"VP",
"CEO",
"CFO",
"General Counsel",
"Other"
],
"type": "string"
},
"contact_last_name": {
"type": "string"
},
"contact_phone": {
"description": "A US number the carriers can reach.",
"type": "string"
},
"contact_title": {
"description": "As the contact signs, e.g. Owner.",
"type": "string"
},
"industry": {
"enum": [
"AUTOMOTIVE",
"AGRICULTURE",
"BANKING",
"CONSTRUCTION",
"CONSUMER",
"EDUCATION",
"ENGINEERING",
"ENERGY",
"OIL_AND_GAS",
"FAST_MOVING_CONSUMER_GOODS",
"FINANCIAL",
"FINTECH",
"FOOD_AND_BEVERAGE",
"GOVERNMENT",
"HEALTHCARE",
"HOSPITALITY",
"INSURANCE",
"LEGAL",
"MANUFACTURING",
"MEDIA",
"ONLINE",
"PROFESSIONAL_SERVICES",
"RAW_MATERIALS",
"REAL_ESTATE",
"RELIGION",
"RETAIL",
"JEWELRY",
"TECHNOLOGY",
"TELECOMMUNICATIONS",
"TRANSPORTATION",
"TRAVEL",
"ELECTRONICS",
"NOT_FOR_PROFIT"
],
"type": "string"
},
"legal_business_name": {
"description": "Exactly as on the IRS EIN letter.",
"type": "string"
},
"postal_code": {
"description": "5-digit ZIP, or ZIP+4.",
"type": "string"
},
"state": {
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY",
"PR",
"VI",
"GU",
"AS",
"MP"
],
"type": "string"
},
"street": {
"description": "Must match the address the IRS has.",
"type": "string"
},
"text_types": {
"description": "service: replies and follow-ups to people who contacted the business. service_and_sales: also lets sales texts go to people who opted in to marketing.",
"enum": [
"service",
"service_and_sales"
],
"type": "string"
},
"website_url": {
"description": "Carriers check the site loads.",
"type": "string"
}
},
"required": [
"business_id"
],
"type": "object"
},
"name": "save_text_registration_details",
"outputSchema": {
"additionalProperties": true,
"properties": {
"consent_url": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"missing": {
"items": {
"type": "object"
},
"type": "array"
},
"next_question": {
"type": "object"
},
"next_step": {
"type": "string"
},
"next_step_text": {
"type": "string"
},
"registration": {
"type": "object"
},
"saved": {
"type": "boolean"
},
"saved_steps": {
"items": {
"type": "string"
},
"type": "array"
},
"setup_url": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Search the carrier for phone numbers available to purchase (live number inventory). In the acquisition flow this follows set_owner_phone, which saves a reachable owner number or records a decline.",
"inputSchema": {
"properties": {
"area_code": {
"description": "Preferred area code (optional).",
"type": "string"
},
"business_id": {
"description": "Search that business's carrier inventory (optional; defaults to the platform carrier).",
"type": "string"
},
"country": {
"description": "Two-letter country code (default US).",
"type": "string"
},
"limit": {
"description": "Max results to return (default 10, max 20).",
"maximum": 20,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "search_available_numbers",
"outputSchema": {
"additionalProperties": true,
"properties": {
"available_numbers": {
"items": {
"type": "string"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send Kai a short note on a live call it is making for the person, to steer it: a detail to mention, a question to add, a preference. Kai uses it on its next turn without reading it out. It never overrides Kai's honesty and disclosure rules. Up to 10 notes a call.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"call_id": {
"description": "The KaiCalls call ID from make_call",
"type": "string"
},
"note": {
"description": "What Kai should know or do, in one or two sentences (up to 500 characters)",
"maxLength": 500,
"type": "string"
}
},
"required": [
"call_id",
"note"
],
"type": "object"
},
"name": "send_call_note",
"outputSchema": {
"additionalProperties": true,
"properties": {
"call_id": {
"type": "string"
},
"code": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"notes_sent": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send an authorized text reply inside an existing Google LSA message lead through the Ads API. This contacts the customer. Requires current business admin role and a stable idempotency_key. A retry with the same key is deduplicated; pending/unknown writes are blocked. Provider acceptance does not prove customer delivery. Attachments are unsupported.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"idempotency_key": {
"maxLength": 150,
"minLength": 1,
"type": "string"
},
"lead_id": {
"format": "uuid",
"type": "string"
},
"message": {
"maxLength": 10000,
"minLength": 1,
"type": "string"
}
},
"required": [
"business_id",
"lead_id",
"message",
"idempotency_key"
],
"type": "object"
},
"name": "send_lsa_reply",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send one message to a business's customer on the channel you choose: a text (sms) from one of the business's agent lines, or a WhatsApp message from its connected WhatsApp number. The same consent, Do-Not-Call, quiet-hours and rate gates as the dashboard apply, and a refusal says which one. sms needs from_agent_id; whatsapp needs a number the owner connected to WhatsApp (pass from when there is more than one) and a customer who messaged that number in the last 24 hours. Email is not sent here; draft_email_campaign drafts a campaign the owner reviews and approves. business_id is required when the account has more than one business. The result reports that the provider accepted the message, not that it was delivered.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"body": {
"description": "Message text.",
"type": "string"
},
"business_id": {
"description": "The business sending. Required when the account has more than one.",
"type": "string"
},
"channel": {
"enum": [
"sms",
"whatsapp"
],
"type": "string"
},
"from": {
"description": "whatsapp only: the business's connected WhatsApp number, when it has more than one.",
"type": "string"
},
"from_agent_id": {
"description": "sms only (required): the agent whose phone line sends the text.",
"type": "string"
},
"idempotency_key": {
"description": "Optional caller-supplied key. Completed replays return the original send. New keyed WhatsApp requests reserve a durable intent before dispatch. Uncertain or concurrent replays are refused, and a new key is treated as a new send. Legacy lost receipts remain unverified.",
"type": "string"
},
"lead_id": {
"description": "Optional lead ID to link and honor the lead's automation-pause state.",
"type": "string"
},
"to": {
"description": "Recipient: an E.164 phone number.",
"type": "string"
}
},
"required": [
"channel",
"to",
"body"
],
"type": "object"
},
"name": "send_message",
"outputSchema": {
"additionalProperties": true,
"properties": {
"channel": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"from": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"provider": {
"type": [
"string",
"null"
]
},
"replayed": {
"type": [
"boolean",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"to": {
"type": [
"string",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Send a text from an agent's phone line through the governed messaging API. Provide from_agent_id, to, and message. For the immediate confirmation a customer just requested on a booking form, add purpose: booking_confirmation, the form's actual sms_consent: true, and idempotency_key; this records service consent and allows the requested confirmation after hours. Booking alerts to this business's active admin phone use purpose: booking_alert and idempotency_key. Explicit opt-outs, content controls and rate limits remain enforced. Use dispatch_policy: queue_if_needed to defer ordinary messages outside their allowed window. Optionally link lead_id; it must belong to this business and match the recipient phone.",
"inputSchema": {
"properties": {
"consent_language": {
"description": "The disclosure shown on the form, when available.",
"type": "string"
},
"dispatch_policy": {
"enum": [
"send_now",
"queue_if_needed"
],
"type": "string"
},
"from_agent_id": {
"description": "Agent ID whose phone line the text is sent from.",
"type": "string"
},
"idempotency_key": {
"description": "Optional caller-supplied key. A replay with the same key returns the original send outcome instead of sending again — so a retry after an uncertain response is safe.",
"type": "string"
},
"lead_id": {
"description": "Optional lead ID to link and honor the lead's automation-pause state.",
"type": "string"
},
"message": {
"description": "Text message body.",
"type": "string"
},
"purpose": {
"description": "Booking confirmation attests the customer just requested this text; booking_alert requires an active business admin recipient. Requires idempotency_key.",
"enum": [
"booking_confirmation",
"booking_alert"
],
"type": "string"
},
"sms_consent": {
"description": "Actual service-message opt-in captured on the booking form. Never infer or invent it.",
"type": "boolean"
},
"sms_opt_in": {
"description": "Existing form consent alias, for example yes.",
"type": "string"
},
"source_url": {
"description": "Optional HTTPS booking-form URL for consent provenance.",
"type": "string"
},
"submission_id": {
"description": "Optional original submission ID; defaults to the idempotency key.",
"type": "string"
},
"submitted_at": {
"description": "Optional original form-submission ISO timestamp. Must be recent for an immediate reply.",
"type": "string"
},
"to": {
"description": "Recipient phone number in E.164 format (e.g. +18135551234).",
"type": "string"
}
},
"required": [
"from_agent_id",
"to",
"message"
],
"type": "object"
},
"name": "send_sms",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"from": {
"type": [
"string",
"null"
]
},
"message_sid": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"to": {
"type": [
"string",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Replace the extra addresses that get the monthly invoice email (at most 3; an empty list clears them). The business owner always keeps getting every invoice and cannot be removed. Requires the current owner role on the business.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"emails": {
"description": "The full list of extra invoice email addresses. Replaces the current list; [] clears it.",
"items": {
"format": "email",
"type": "string"
},
"maxItems": 3,
"type": "array"
}
},
"required": [
"emails"
],
"type": "object"
},
"name": "set_billing_contacts",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"extra_emails": {
"items": {
"type": "string"
},
"type": "array"
},
"max_extra_emails": {
"type": "integer"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "File the business name that landlines show when the business's number calls out (caller ID name). Included with the business's own text registration once it is paid; charges nothing. Business owner only. The name must be at most 15 characters, start with a letter, and use only letters, numbers, periods, commas and spaces (get_text_registration returns a suggestion in branded_caller_id.suggestedName). Files with the carriers once the business profile is approved; review then takes a day or two and carriers show it within 72 hours. US local numbers only. The result confirms the filing, not that the name is showing on calls.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"display_name": {
"description": "Up to 15 characters, e.g. SUMMIT ROOFING.",
"type": "string"
}
},
"required": [
"business_id",
"display_name"
],
"type": "object"
},
"name": "set_branded_caller_id",
"outputSchema": {
"additionalProperties": true,
"properties": {
"branded_caller_id": {
"type": "object"
},
"charged": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Change the business's opening hours, timezone, or one-off closed dates (\"we're closed Friday the 27th\"). Same change as the dashboard's hours page, admin role required. Only the days you pass change; every other day keeps what it had. A day is { open: 'HH:MM', close: 'HH:MM' } in 24-hour time, or { closed: true }. closed_dates adds dates the business is shut; reopen_dates removes them. Call routing that follows business hours uses the new hours from the next call. Returns the saved week as read back.",
"inputSchema": {
"properties": {
"business_id": {
"description": "The business. Required when the account has more than one.",
"type": "string"
},
"closed_dates": {
"description": "Dates the business is closed, e.g. [{ date: \"2026-11-27\", name: \"Thanksgiving\" }].",
"items": {
"properties": {
"date": {
"description": "YYYY-MM-DD",
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"date"
],
"type": "object"
},
"type": "array"
},
"hours": {
"additionalProperties": {
"properties": {
"close": {
"description": "24-hour HH:MM",
"type": "string"
},
"closed": {
"type": "boolean"
},
"open": {
"description": "24-hour HH:MM",
"type": "string"
}
},
"type": "object"
},
"description": "Days to change, keyed monday..sunday. Example: { saturday: { open: '09:00', close: '13:00' }, sunday: { closed: true } }.",
"type": "object"
},
"reopen_dates": {
"description": "Closed dates to remove (YYYY-MM-DD).",
"items": {
"type": "string"
},
"type": "array"
},
"timezone": {
"description": "IANA timezone, e.g. America/Chicago (optional).",
"type": "string"
}
},
"type": "object"
},
"name": "set_business_hours",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_hours": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": "string"
},
"changed_days": {
"items": {
"type": "string"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"holidays": {
"items": {
"type": "object"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"timezone": {
"type": "string"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Change the recording notice or AI notice callers hear before the greeting, or when each plays. The next call uses the new wording. Requires the business owner. Turning a notice to never can break recording or AI-disclosure law for callers in states that require one; state_gated is the safe default. Every change is logged with the previous value.",
"inputSchema": {
"properties": {
"ai_disclosure_enabled": {
"description": "Legacy switch; false turns the AI notice off entirely.",
"type": "boolean"
},
"ai_disclosure_message": {
"description": "What callers hear about talking to an AI. Up to 300 characters.",
"type": "string"
},
"ai_disclosure_mode": {
"description": "When the AI notice plays.",
"enum": [
"always",
"state_gated",
"never"
],
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
},
"dry_run": {
"description": "Validate and show the proposed settings without writing.",
"type": "boolean"
},
"record_calls_by_default": {
"description": "Whether calls are recorded. With recording off, no recording notice plays.",
"type": "boolean"
},
"recording_disclosure_message": {
"description": "What callers hear about recording, e.g. \"This call is recorded.\" Up to 300 characters.",
"type": "string"
},
"recording_disclosure_mode": {
"description": "When the recording notice plays.",
"enum": [
"always",
"state_gated",
"never"
],
"type": "string"
}
},
"type": "object"
},
"name": "set_call_disclosures",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"dry_run": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"previous": {
"type": [
"object",
"null"
]
},
"settings": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Set who answers a customer's text conversation. owner 'ai' (the default): Kai replies. 'human': Kai stays quiet and the business owner answers. 'external': Kai stays quiet and the business's own system answers; it receives the sms.received webhook and replies with send_message or POST /v1/messages. With external_reply_timeout_seconds (external only, 60 to 86400), Kai answers a message nothing replied to in that time. Messages are always stored and sms.received always fires. Pass conversation_id for one conversation, or phone for every conversation the business has with that customer. Re-sending the same owner changes nothing.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "Required when the account has more than one business and only phone is given.",
"type": "string"
},
"conversation_id": {
"description": "One conversation. Either this or phone is required.",
"type": "string"
},
"external_reply_timeout_seconds": {
"description": "owner 'external' only: Kai answers when nothing replied in this many seconds.",
"type": [
"integer",
"null"
]
},
"owner": {
"enum": [
"ai",
"human",
"external"
],
"type": "string"
},
"phone": {
"description": "The customer's number (E.164): every conversation the business has with it.",
"type": "string"
}
},
"required": [
"owner"
],
"type": "object"
},
"name": "set_conversation_owner",
"outputSchema": {
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"conversation_id": {
"type": [
"string",
"null"
]
},
"conversations": {
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"external_reply_timeout_seconds": {
"type": [
"integer",
"null"
]
},
"owner": {
"type": [
"string",
"null"
]
},
"owner_set_at": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Saves the owner's own mobile number on the business record (the number Kai texts whenever it takes a call for the owner) so Kai can ring it first and so activation/forwarding follow-ups can reach a human — connecting a number alone does not prove the owner can be reached. In the acquisition flow this step comes before search_available_numbers and buy_number (#2086). US numbers only; normalized to E.164 and rejected if it cannot be validated as a US mobile/landline number. When ring_first is true (default), also configures ring-first routing so calls hit this cell before overflowing to the secretary — the same path used at signup. declined=true, in place of owner_phone, records a caller who declines to give a number as an inquiry: a KaiCalls lead, with no provisioned business or number.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"contact_email": {
"description": "Only used with declined=true: an email for the inquiry record, if given.",
"type": "string"
},
"contact_name": {
"description": "Only used with declined=true: the caller name, for the inquiry record.",
"type": "string"
},
"declined": {
"description": "True (in place of owner_phone) when the caller will not give a reachable number. Records the business as an inquiry lead instead of a provisioned number.",
"type": "boolean"
},
"owner_phone": {
"description": "The owner's own mobile number, US format (e.g. (908) 555-1234 or +19085551234). Required unless declined is true.",
"type": "string"
},
"ring_first": {
"description": "When true (default), ring this number first and overflow to the secretary. When false, only saves the number.",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": "set_owner_phone",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"next_step": {
"type": "string"
},
"owner_phone_masked": {
"type": [
"string",
"null"
]
},
"owner_phone_present": {
"type": "boolean"
},
"ring_first_applied": {
"type": "boolean"
},
"ring_first_status": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Change how the business screens scam calls, or which numbers are never screened. mode: off, label (default; nothing is blocked) or screen (callers with a strong scam sign, such as a caller ID the carrier could not verify or a number already caught scamming, get a short screen that takes their name and reason instead of the normal line). Known customers and the team are never screened. allowlist replaces the whole list. Requires an admin of the business. The next call uses the change.",
"inputSchema": {
"properties": {
"allowlist": {
"description": "Phone numbers never screened. Replaces the saved list. Up to 200.",
"items": {
"type": "string"
},
"type": "array"
},
"business_id": {
"description": "Business ID (optional only when the token has exactly one accessible business)",
"type": "string"
},
"dry_run": {
"description": "Validate and show the proposed settings without writing.",
"type": "boolean"
},
"mode": {
"enum": [
"off",
"label",
"screen"
],
"type": "string"
}
},
"type": "object"
},
"name": "set_scam_screening",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"dry_run": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"previous": {
"type": [
"object",
"null"
]
},
"settings": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Optional line customization: sets the business name and greeting Kai answers with, as the owner requested. Not required to make calls, and never changes payment, usage or fraud limits. Extra business details are optional; no business-qualification questionnaire is needed. An existing business greeting is left unchanged.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"description": "The account to set up. Optional when the token reaches one account.",
"type": "string"
},
"business_name": {
"description": "The business's real name.",
"type": "string"
},
"website": {
"description": "The business's website, if it has one.",
"type": "string"
},
"what_you_sell": {
"description": "What the business sells or does, in the owner's words.",
"type": "string"
},
"who_kai_will_call": {
"description": "Who the owner wants Kai to call, e.g. other businesses, existing customers, or people who asked for a callback.",
"type": "string"
}
},
"required": [
"business_name"
],
"type": "object"
},
"name": "set_up_business",
"outputSchema": {
"additionalProperties": true,
"properties": {
"already_business": {
"type": "boolean"
},
"business_id": {
"type": "string"
},
"changed": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"greeting_updated": {
"type": "boolean"
},
"persona_mode": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Turn the business's number into a hosted phone system: Kai is installed as extension 700, the owner's mobile joins the list of phones to ring first, and calls reach Kai when nobody picks up. Idempotent and resumable — a re-run reuses everything already created and reports it under `reused`. Needs a complete US street address on file (the emergency-services and tax location) and the owner's mobile: when either is missing the tool fails with `code` missing_address or missing_owner_mobile plus `required_field` and `next_action` naming exactly what is missing, which business_address or owner_mobile accepts. Returns the status shape (existing setup IDs, extension and the phone-system line) and `next_step`, the owner's next action in one line (forward your line here / dial 700 from any office phone).",
"inputSchema": {
"properties": {
"business_address": {
"description": "The business street address to save before provisioning. Optional when a complete address is already on file; required when the last attempt returned missing_address.",
"properties": {
"city": {
"type": "string"
},
"state": {
"description": "Two-letter US state code.",
"type": "string"
},
"street": {
"description": "Street number and name.",
"type": "string"
},
"zip": {
"description": "5-digit US ZIP code.",
"type": "string"
}
},
"required": [
"street",
"city",
"state",
"zip"
],
"type": "object"
},
"business_id": {
"description": "Business ID (required when the token can access multiple businesses).",
"type": "string"
},
"owner_mobile": {
"description": "The owner's own mobile number (US). Optional when set_owner_phone already saved one; required when the last attempt returned missing_owner_mobile.",
"type": "string"
},
"persona": {
"description": "Which phones the business runs on, if the owner said: cell_only (just the owner's cell) or office (desk phones / an existing office line that will forward in). Shapes next_step; optional.",
"enum": [
"cell_only",
"office"
],
"type": "string"
}
},
"type": "object"
},
"name": "set_up_phone_system",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"code": {
"description": "Present when success is false.",
"type": "string"
},
"created": {
"items": {
"type": "string"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"ids": {
"type": "object"
},
"issues": {
"description": "Address fields to correct when code is invalid_address.",
"items": {
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"kai_extension": {
"type": "string"
},
"line": {
"description": "The phone-system line (E.164), if a number is attached.",
"type": [
"string",
"null"
]
},
"next_action": {
"description": "What to collect and how to retry, when blocked.",
"type": "string"
},
"next_step": {
"description": "The one line to relay to the owner.",
"type": "string"
},
"provisioned": {
"type": "boolean"
},
"required_field": {
"description": "Present when setup is blocked on a missing input.",
"enum": [
"business_address",
"owner_mobile"
],
"type": "string"
},
"reused": {
"items": {
"type": "string"
},
"type": "array"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create or update a business outbound webhook (URL + subscribed events). Returns a webhook secret on first creation only.",
"inputSchema": {
"properties": {
"body_format": {
"description": "json (default) or form (application/x-www-form-urlencoded, nested keys flattened with dots).",
"enum": [
"json",
"form"
],
"type": "string"
},
"business_id": {
"description": "Business ID (optional only when the token can access exactly one business).",
"type": "string"
},
"custom_headers": {
"description": "Extra headers the CRM needs, as { \"Header-Name\": \"value\" } (max 20). A null value keeps the saved value for that name. Content-Type, Host, Content-Length and X-KaiCalls-* cannot be set. Values are never returned.",
"type": [
"object",
"null"
]
},
"description": {
"description": "Human label for this webhook.",
"type": "string"
},
"events": {
"description": "Event types to subscribe to (get_webhook lists the supported types).",
"items": {
"type": "string"
},
"type": "array"
},
"http_method": {
"description": "HTTP method for delivery (default POST).",
"enum": [
"POST",
"PUT",
"PATCH"
],
"type": "string"
},
"id": {
"description": "Existing webhook ID to update (omit to create new).",
"type": "string"
},
"is_active": {
"description": "Enable or disable delivery.",
"type": "boolean"
},
"payload_template": {
"description": "Shape the body for a CRM: { \"fields\": { \"<their field>\": \"<path>\" | { \"value\": <fixed> } } }. A path reads the standard event body (e.g. \"data.phone\", \"occurred_at\"); \"a|b\" takes the first with a value; a dot in the field name nests it (\"contact.phone\"). Missing paths send null. null restores the standard body.",
"type": [
"object",
"null"
]
},
"preset": {
"description": "Start the body from a CRM field map. Presets are editable starting points, not exact vendor formats. Ignored when payload_template is also sent.",
"enum": [
"generic_crm",
"litify",
"filevine",
"clio_grow",
"lead_docket",
"gohighlevel"
],
"type": "string"
},
"webhook_url": {
"description": "HTTPS/HTTP destination URL for event delivery.",
"type": "string"
}
},
"required": [
"webhook_url"
],
"type": "object"
},
"name": "set_webhook",
"outputSchema": {
"additionalProperties": true,
"properties": {
"business_id": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"events": {
"items": {
"type": "string"
},
"type": "array"
},
"message": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"webhook": {
"type": "object"
},
"webhook_secret": {
"type": [
"string",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Owner only: publish a finished errand call as a redacted transcript example (no audio, business shown as a category). Call once for a preview, show it, then confirm with its preview_hash.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_category": {
"description": "What kind of business was called, shown instead of its name (default business)",
"enum": [
"business",
"cable_internet",
"phone_carrier",
"utility",
"insurance",
"bank",
"pharmacy",
"doctor",
"dentist",
"vet",
"law_firm",
"landlord",
"auto_shop",
"contractor",
"repair_shop",
"restaurant",
"store",
"salon",
"gym",
"subscription",
"government",
"school"
],
"type": "string"
},
"call_id": {
"description": "The finished errand call to share",
"type": "string"
},
"confirm": {
"description": "True only after the owner has seen the preview and asked to publish it. Without it nothing is published.",
"type": "boolean"
},
"errand": {
"description": "The kind of errand, if one fits (optional)",
"enum": [
"lower-a-bill",
"cancel-a-subscription",
"prescription",
"book-an-appointment",
"get-a-quote"
],
"type": "string"
},
"outcome": {
"description": "What happened, in the owner’s words, 600 characters or fewer. Defaults to the call summary (optional)",
"type": "string"
},
"preview_hash": {
"description": "The preview_hash from the preview the owner approved. Required with confirm.",
"type": "string"
},
"title": {
"description": "Short title in the owner’s words, 120 characters or fewer. Personal details are removed (optional)",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "share_call_example",
"outputSchema": {
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"examples_url": {
"type": "string"
},
"preview": {
"type": "object"
},
"published": {
"type": "boolean"
},
"shared_at": {
"type": [
"string",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Let Kai's outbound calls show a number the person already owns (their cell or an old main line) instead of a KaiCalls line, so people recognize who is calling. A verification call goes to that number and returns a code; the person answers and types the code on the keypad. Then get_own_caller_id confirms it. Ownership is proven only by that call. US and Canada numbers. Business owner only. Charges nothing. Callbacks to the shown number reach that phone, not Kai. use_by_default (default true) shows it on every call unless make_call asks for caller_id 'business_line'. Starting a new number replaces the old one.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"phone_number": {
"description": "The number to show, e.g. +19085551234. It must ring a phone the person can answer.",
"type": "string"
},
"use_by_default": {
"description": "Show it on every call unless a call asks otherwise (optional, default true).",
"type": "boolean"
}
},
"required": [
"phone_number"
],
"type": "object"
},
"name": "start_own_caller_id",
"outputSchema": {
"additionalProperties": true,
"properties": {
"charged": {
"type": "boolean"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"own_caller_id": {
"type": "object"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"validation_code": {
"type": "string"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create the payment link for a business's own carrier registration (a one-time filing fee plus a monthly campaign fee). Business owner only, and only once the details and the EIN are saved. An admin who prepared the details gets owner_required with owner_handoff_url: the page the owner opens to type the EIN, review and confirm. Returns checkout_url for the owner to open and pay; nothing is charged by this tool, and filing starts only after payment. A checkout_url means neither payment nor filing. On a plan that includes registration there is nothing to pay: the tool sends it to the carriers straight away and returns included_in_plan and filed true instead of a link, so that path requires confirm_submission true, which records that the owner reviewed and confirmed the saved details and external submission. Submission is not carrier approval. The tool takes no EIN, document contents, credentials or legal attestations.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"confirm_submission": {
"description": "True only after the owner explicitly confirms the saved details and possible immediate carrier submission.",
"type": "boolean"
}
},
"required": [
"business_id",
"confirm_submission"
],
"type": "object"
},
"name": "start_text_registration_checkout",
"outputSchema": {
"additionalProperties": true,
"properties": {
"charged": {
"type": "boolean"
},
"checkout_url": {
"type": "string"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"filed": {
"type": "boolean"
},
"included_in_plan": {
"type": "boolean"
},
"monthly_usd": {
"type": "number"
},
"one_time_usd": {
"type": "number"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Reserved submission contract; execution is currently unavailable and returns submission_unavailable without filing. Shared durable reservation and unknown-outcome reconciliation across dashboard, checkout and cron are prerequisites. Preparation and status are handled by get_text_registration and save_text_registration_details. Saving corrected details does not resubmit existing rejected provider objects: operator reconciliation is required. Another entry point or a new paid registration would duplicate the filing. It accepts no tax identifiers, credentials, file contents or legal attestations. Owner membership and billing:write required.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"type": "string"
},
"confirm_submission": {
"type": "boolean"
},
"expected_updated_at": {
"type": "string"
}
},
"required": [
"business_id",
"expected_updated_at",
"confirm_submission"
],
"type": "object"
},
"name": "submit_text_registration",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"prerequisite": {
"type": "string"
},
"submission_attempted": {
"const": false,
"type": "boolean"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Sync an explicitly selected connected LSA advertiser. Requires current business admin role. Syncing runs lead ingestion, and existing business speed-to-lead configuration may contact the new leads it finds.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"business_id": {
"format": "uuid",
"type": "string"
},
"connection_id": {
"format": "uuid",
"type": "string"
}
},
"required": [
"business_id",
"connection_id"
],
"type": "object"
},
"name": "sync_lsa",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Teach the agent one rule from a coaching point on a call (get_coaching gives the code and a suggested rule). The rule is added to a Coaching rules section of the agent's instructions through the governed update path, so it is versioned, in change history and can be rolled back; a business owner or admin signed in through this connector applies it right away, otherwise it waits for the owner. Then a test is built from that call and run, and the result says whether the agent now follows the rule.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID. Required when the key can reach more than one business.",
"type": "string"
},
"call_id": {
"description": "The call the coaching point is on.",
"type": "string"
},
"code": {
"description": "The coaching point code from get_coaching.",
"type": "string"
},
"rule": {
"description": "One plain instruction the agent should follow on every call (8-300 characters). Usually the suggested rule from get_coaching.",
"type": "string"
}
},
"required": [
"call_id",
"code",
"rule"
],
"type": "object"
},
"name": "teach_coaching_rule",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"rule": {
"type": "string"
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"test": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Owner only: take a shared call example down.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"call_id": {
"description": "The shared call to take down",
"type": "string"
}
},
"required": [
"call_id"
],
"type": "object"
},
"name": "unshare_call_example",
"outputSchema": {
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"unshared": {
"type": "boolean"
},
"unshared_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Edit an agent's live runtime configuration — greeting/first message, inbound or SMS prompt, the after-call summary and lead-score instructions, voice, language model, max call duration, and call-transfer settings — routed through the governed update broker so every change keeps the consent + audit trail (a versioned config snapshot and change history). Read get_agent_config first; inbound_prompt replaces the whole prompt. Each applied change is saved as a version (list_config_versions); rollback_config can restore a version's greeting, voice, prompt, model and summary/scoring, but not transfer settings or call length. Mutating changes need an idempotency_key. When the business owner or an admin is signed in through this connector, their own changes apply immediately. High-impact live changes made with an API key or on someone else's behalf queue for the owner's review instead (the owner is notified with a review link). configure_agent_business_rules edits a single named operational-rules section.",
"inputSchema": {
"properties": {
"actor": {
"description": "Do not set. Kept for older clients; the signed-in connection identifies you.",
"type": "object"
},
"agent_id": {
"description": "KaiCalls agent ID to update.",
"type": "string"
},
"authority": {
"description": "Do not set. It cannot approve a change: the owner approves through review_url or by being signed in.",
"type": "object"
},
"business_id": {
"description": "Business ID. Required when the agent has multiple accessible assignments.",
"type": "string"
},
"call_summary_instructions": {
"description": "How the summary written after each call should read, in plain language (for example \"Write exactly two sentences for the attorney...\"). Changes only the summary; the prompt and scoring stay as they are. get_operational_settings shows the current text.",
"type": "string"
},
"dry_run": {
"description": "Validate and summarize the change without writing.",
"type": "boolean"
},
"first_message": {
"description": "Spoken greeting / first message callers hear.",
"type": "string"
},
"idempotency_key": {
"description": "Required for writes. Reuse the same key when retrying the same change.",
"type": "string"
},
"inbound_prompt": {
"description": "The whole inbound prompt; it replaces the current one. Start from inbound_prompt in get_agent_config, never from a saved version.",
"type": "string"
},
"lead_score_instructions": {
"description": "How each caller is scored from 0 to 100, in plain language. Changes only the scoring. End it with \"Respond with ONLY a number from 0 to 100.\"",
"type": "string"
},
"max_duration": {
"description": "Maximum call duration in seconds.",
"type": "integer"
},
"model": {
"description": "Language model selection: { provider, model, temperature }.",
"type": "object"
},
"name": {
"description": "Agent display name.",
"type": "string"
},
"outbound_prompt": {
"description": "Outbound (campaign) system prompt.",
"type": "string"
},
"queue_for_approval": {
"description": "When authority is missing, create a pending dashboard approval instead of returning needs_approval.",
"type": "boolean"
},
"reason": {
"description": "Why this change is being made. Kept in the change history.",
"type": "string"
},
"sms_prompt": {
"description": "SMS reply prompt.",
"type": "string"
},
"source_ref": {
"description": "External source reference, such as a support ticket or conversation ID.",
"type": "string"
},
"transfer_enabled": {
"description": "Enable/disable live call transfer.",
"type": "boolean"
},
"transfer_phone_number": {
"description": "Number to transfer qualified calls to.",
"type": "string"
},
"voice": {
"description": "Voice selection: { provider, voiceId }. Use voice_catalog_id instead when you can.",
"type": "object"
},
"voice_catalog_id": {
"description": "Preferred way to pick a voice: an id from list_voices.",
"type": "string"
}
},
"required": [
"agent_id"
],
"type": "object"
},
"name": "update_agent_config",
"outputSchema": {
"additionalProperties": true,
"properties": {
"agent_id": {
"type": [
"string",
"null"
]
},
"approval": {
"type": [
"object",
"null"
]
},
"business_id": {
"type": [
"string",
"null"
]
},
"code": {
"type": [
"string",
"null"
]
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
},
"request_id": {
"type": [
"string",
"null"
]
},
"result": {
"type": [
"object",
"null"
]
},
"risk_level": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"summary": {
"type": [
"object",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Replace how calls ring on the business's hosted phone system with a full phone flow: { version: 1, hours: { mode: 'always' | 'business_hours', afterHours: 'kai' }, ring: { members: [{ kind: 'cell', phone: E.164, label, requirePressOne } | { kind: 'desk_phone' | 'user', userId, label }], timeoutSeconds: 5-120 }, overflow: 'kai' }. Applied idempotently (only real differences are written); every member passes the forwarding-loop guard; business_hours mode derives the schedule from the business hours already on file. Because it replaces the whole flow, the input is the full flow as get_phone_flow returns it, with changes applied.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID (required when the token can access multiple businesses).",
"type": "string"
},
"flow": {
"description": "The complete phone flow to apply.",
"type": "object"
}
},
"required": [
"flow"
],
"type": "object"
},
"name": "update_phone_flow",
"outputSchema": {
"additionalProperties": true,
"properties": {
"changes": {
"items": {
"type": "string"
},
"type": "array"
},
"error": {
"description": "Present when success is false",
"type": "string"
},
"flow": {
"type": "object"
},
"readback": {
"type": "string"
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create a new agent knowledge base entry, or update one when `id` is provided. Creating requires title, content, and content_type.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID. Required for create when the token can access multiple businesses.",
"type": "string"
},
"category": {
"type": "string"
},
"content": {
"type": "string"
},
"content_type": {
"type": "string"
},
"id": {
"description": "Knowledge item ID to update (omit to create).",
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"type": "string"
}
},
"type": "object"
},
"name": "upsert_knowledge",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"knowledge": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create a new lead or update existing leads for the authenticated business, routed through the governed leads API (business access-checked, usage-logged, and audited). To create one, pass `lead` with at least one of name/phone/email plus optional status/source/notes/agent_id/etc. To update, pass `updates`: an array of { id, ...fields } for one or many existing leads (status, name, phone, email, notes, address, city, state, zip). Updates are access-checked per row and report partial success.",
"inputSchema": {
"properties": {
"business_id": {
"description": "Business ID. Required for create when the API key can access multiple businesses.",
"type": "string"
},
"lead": {
"description": "Fields for a NEW lead: name, first_name, last_name, phone, email, status, source, notes, address, city, state, zip, agent_id, message. At least one of name/phone/email is required.",
"type": "object"
},
"updates": {
"description": "Update existing leads. Each item is { id, ...fields } where fields are a subset of name, first_name, last_name, email, phone, status, source, notes, address, city, state, zip. Max 100 per call.",
"items": {
"properties": {
"id": {
"description": "Lead ID to update.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"name": "upsert_lead",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"failed": {
"type": [
"integer",
"null"
]
},
"lead": {
"type": [
"object",
"null"
]
},
"operation": {
"description": "create or update",
"type": "string"
},
"results": {
"items": {
"type": "object"
},
"type": [
"array",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
},
"updated": {
"type": [
"integer",
"null"
]
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Create a new product row, or update one when `id` is provided. Creating requires name and business_id. Pass `quantity` to set/update inventory.",
"inputSchema": {
"properties": {
"attributes": {
"type": "object"
},
"business_id": {
"description": "Business ID. Required for create when the token can access multiple businesses.",
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"description": "Product ID to update (omit to create).",
"type": "string"
},
"name": {
"type": "string"
},
"price": {
"type": "number"
},
"quantity": {
"description": "Inventory quantity to set (optional).",
"type": "number"
},
"sku": {
"type": "string"
}
},
"type": "object"
},
"name": "upsert_product",
"outputSchema": {
"additionalProperties": true,
"properties": {
"error": {
"description": "Present when success is false",
"type": "string"
},
"product": {
"type": [
"object",
"null"
]
},
"success": {
"description": "Whether the tool completed successfully",
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:630c0b72f8686384078214ee5bdd6dcbb8373632a010c433afb3ea8a86b4dc65 | sha256sum