Ciarem AI

Admins only. Results of an AI check run (default: the latest): status, score and pass/warn/fail counts, then each failed or warned scenario with the judge's reasoning and the transcript. `config_changed_since_last_run` says whether the setup changed after the latest run.

get_ai_check_results

Admins only. How the AI agent performed in production over the period: AI turns, the share it handled vs transferred, fallback and error rates, reply latency (p50/p95 ms), average confidence, the transfer rules that fired most, and a `status` (healthy, degraded, at_risk, or insufficient_data below 10 turns).

get_ai_performance

Admins only. When the AI hands a conversation to a person and who receives it: every transfer rule in evaluation order (condition, priority, enabled, target, schedule) and the assignment rules (owner priority, advisor pool, strategy, reassignment).

get_ai_routing

Admins only. Whether the workspace's AI agent is ready to answer customers and what to fix: readiness checks, open recommended actions, and each connected channel's status.

get_account_health

Who is connected: the signed-in Ciarem user and the workspace (organization) this connection reads from. `setup_required` (admins only) means the workspace is brand new and was never set up: offer to set it up (set_up_workspace) before anything else.

get_profile

One contact's details plus their 5 most recent conversations. `contact_id` comes from search_contacts or a conversation.

get_contact

One conversation with its latest messages in reading order (oldest first), including internal team notes. `limit` caps the messages (max 50).

get_conversation

One help-center article as markdown, in `language` when it is translated (else English). `path` must be a path from list_help_articles, verbatim. Answer how-to questions from it with short steps and link its `url`.

get_help_article

Admins only. Questions customers asked recently that the AI's knowledge could not answer, most frequent first, with sample customer messages and channels. Each one is content worth adding to the knowledge base.

get_knowledge_gaps

Admins only. One knowledge source in full: the text of a pasted source, the crawled pages of a website, and the lines flagged as behaviour rules. `source_id` comes from list_knowledge_sources or a search_knowledge match.

get_knowledge_source

Admins only. Conversation counts for the last 24 hours or 7 days (active, handled by the AI, new leads, awaiting reply, per channel) and the team leaderboard (assigned, sent, resolved, median reply time in seconds).

get_metrics

Admins only. The workspace's AI response evaluations, where the AI's real replies are grouped into categories and an admin marks each category adequate or needing correction. Returns the 5 latest evaluations and, for `eval_id` (default: the latest), its categories with verdict, the correction applied and a few example exchanges.

get_response_evaluations

Admins only. Where the workspace's first-time setup stands: whether it still needs setting up, whether the AI is configured, the agents, and the website being read (`website.ready` false = still reading; wait and call again before testing). `website.status` ERROR means the site couldn't be read: tell the user, and add the key facts with add_knowledge_text instead.

get_setup_status

Inbox conversations, most recent first: who, channel, status, whether the AI or a human handles it, unread count and the last message. Filter by status, channel, `assigned_to_me`, `unassigned`, or a `query` over names and message text. Up to `limit` (max 25).

list_conversations

Index of the Ciarem help center (help.ciarem.ai): every article's path, title, section and one-line summary. Use it for how-to questions about Ciarem, e.g. how to fix what another tool found, then call get_help_article with the matching path.

list_help_articles

Admins only. Every knowledge source the AI answers from, grouped by knowledge base: name, type (FREE_TEXT, FILE_PDF, FILE_TXT, WEBSITE), indexing status, fragment count, a preview, and `holds_instructions` (behaviour rules stored as knowledge, which belong in coaching instead).

list_knowledge_sources

Admins only. Delete one coaching rule. `bullet` is the rule's text exactly as get_ai_setup lists it (`org_wide_coaching`, or the agent's `coaching` with that `agent_id`).

remove_coaching

Admins only. Start the workspace's AI check suite: built-in scenarios plus one per saved coaching rule, each replayed on the real agents and judged. It takes a few minutes; then call get_ai_check_results. Run it after a round of changes to catch one that broke something else.

run_ai_checks

Find contacts (customers and leads) in Ciarem by name, phone or email. `funnel_stage` (a stage name, e.g. "Interesado") and `owned_by_me` narrow the list. Returns the total match count and up to `limit` (max 25) contacts, newest first.

search_contacts

Search the workspace's knowledge base (the documents, texts and websites its AI agent answers from). By default it searches by meaning, as the AI agent does. Set `exact` to find where a specific wording appears verbatim (case-insensitive), e.g. to trace which source makes the AI say something. Each match has the passage and its source (`source_id`, name, type, and the page URL for websites).

search_knowledge

Admins only. Send a sample customer message to the workspace's REAL AI agents, with the current configuration, and see what they would reply: the decision (answered, transferred, out of scope), the messages, which agent answered, the transfer rule that fired, the knowledge used and the actions it would take. Nothing is sent to anyone and no contact or record changes. Use it after every change. To continue the same test chat, pass back the returned `test_conversation_id`; omit it to start a new one. `agent_ids` tries only those agents (e.g. a PAUSED one before turning it on). `simulated_now` ("YYYY-MM-DDTHH:MM", workspace time) tests scheduled transfer rules.

test_ai_reply

Admins only. Turn the AI agent on (it answers customers) or off (every conversation waits for a person). Confirm with the user first.

set_ai_active

Admins only. Change the AI agent's global settings; pass only what should change. `tone_example` is one sentence showing how the business sounds (max 300 chars; "" clears it). `first_message` is the welcome that opens every new conversation while `first_message_always` is on ("" = no welcome). Read get_ai_setup first.

update_ai_settings

Admins only. Change one agent (`agent_id` from get_ai_setup); pass only what should change. `when_to_use` is when the router hands it a conversation. `qualification_questions` replaces the whole list (qualifier agents). `purchase_link` ("" clears it) is for sales agents. `follow_up_delays_minutes` (15, 60 or 120 each; [] turns follow-ups off) is the ladder of nudges after the customer goes quiet. `knowledge_base_ids` (ids from list_knowledge_sources) replaces the knowledge bases the agent answers from: an agent only searches the ones bound here. `status` PAUSED stops the agent from taking conversations.

update_agent

Admins only. Change the business profile the AI speaks for; pass only what should change. Each `*_other` (max 80 chars) is required when its field is "other". `audience_notes` (max 1000 chars) describes the customers. A workspace with no profile yet needs company_name, industry, offering and customer_type.

update_business_profile

Admins only. Change one transfer rule (`rule_id` from get_ai_routing); pass only what should change. `target` takes the same values as in create_transfer_rule; `pre_transfer_message` "" clears it; `enabled` turns the rule on or off. The schedule is kept as is (edit it in the dashboard).

update_transfer_rule

Admins only. Change the workspace's timezone (IANA name, e.g. "America/Bogota"; transfer-rule schedules read it), language for emails and invoices (`locale`), and selling currency (ISO 4217 code, e.g. "COP"; catalog prices and orders). Pass only what should change. Returns all three.

update_org_settings