For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tools reference

Everything the assistant can do, grouped by the permission that unlocks it.

Tool names are what the assistant sees. You rarely need them, but they appear in error messages and in the assistant's own explanations, so they are listed here for reference.

Read Project Data and Analytics

These tools are read-only: they never change anything, never ask for confirmation, and do not count against the monthly allowance. Test questions are free and limited to about 30 per project per hour.

Experiences, Users, and Feedback

Tool
What it does

intel_get_project_overview

The project at a glance: users and activity, what is live by type, drafts, experiences expiring soon, best performers, running experiments, activation summary.

intel_list_experiences

Inventory of tours, surveys, banners, hints, checklists, resource centers, and posts with their delivery status.

intel_get_experience_performance

One experience's funnel: completion and engagement rates, with ordered step-by-step drop-off.

intel_get_activation_funnel

Step-by-step activation for a success tracker, optionally for one segment.

intel_compare_cohort_adoption

How up to five segments adopt one experience, against the all-users baseline.

intel_get_experiment_results

A/B results per variant, lift over control, and whether the difference is significant yet.

intel_list_issues

Where experiences break for real users: target element missing, hidden, or ambiguous.

intel_get_user_adoption_profile

One end user: identity, segments, every experience seen with status, activation progress.

segment_list

The project's segments with approximate sizes.

feedback_list_responses

Survey and NPS responses, newest first.

content_get_experience

Reads one experience back as stored: copy, button, image, audience, dashboard link. Experiences built in the dashboard can be richer than this view shows, and the tool says so when parts are not represented.

Jimo Agent

Tool
What it does

agent_get_overview

Where the agent stands, and the setup gaps still open. The place to start.

agent_list_pages

Every screen the agent knows. Pass a URL to see which pages would load there.

agent_get_page

One page: description, rules, elements by name and purpose, suggestions, skills, and the screenshot link.

agent_test_url_rules

Tries rules against real URLs before anything is saved.

agent_list_skills

Every skill, with its type, page, uses, and whether it needs review (10 or more decided runs and under 70% resolved).

agent_get_skill

One skill: instructions, the values it asks for, and the suggestions that start it.

agent_get_skill_performance

Why a skill fails, split into structural causes (a missing element, an unscanned page), which rewriting the instructions does not fix, and instruction issues, which it may.

agent_list_knowledge_sources

Everything the agent is trained on, with training status.

agent_get_knowledge_source

Training progress, the pages a website actually read, and the ones it could not.

agent_test_question

Asks the real agent. Returns the answer, what it looked up (it may not have used all of it), the skill it would offer, the hand-off to a human it would start, and the first page action it would take. That action is not run. Pass a page URL, and the text visible there, to ask from a given screen.

agent_get_performance

Usage, success rate, and escalations by reason and topic, against the previous period. Success rate is likes against dislikes: conversations nobody reacted to do not count.

agent_get_conversation_insights

What end users asked the Jimo Agent, plus a needs-attention feed: unanswered questions, disliked answers, abandoned skill runs.

agent_list_conversations

What end users asked, filtered by text, reaction, escalation, or page.

agent_get_conversation

One transcript.

Manage Experiences

Tool
What it does
Asks to confirm?

content_draft_experience

Creates a draft changelog post, top banner, or pop-in modal from plain text. Drafts are invisible to end users. Images are attached by public URL (there is no upload), and banners carry a title and button only.

No (draft only)

content_update_experience

Rewrites the copy of a draft: title, body, button label and URL, image URL. Nothing else changes.

Only if the draft was also worked on in the dashboard

content_publish_experience

Makes a draft visible in chosen environments, or re-scopes a published experience's environments. Posts skip environment scoping, they are portal content.

Yes

content_set_experience_state

Pauses or resumes a published experience. Not for posts.

Yes

content_set_audience

Sets who an experience targets (saved segments or all users) and when it runs (start and expiry).

Yes

content_translate_experience

Translates every step and block of an experience with Jimo's smart translate, formatting kept. Works on every experience type, draft or published. Adds missing languages by default, or regenerates existing ones after the base copy changed.

Yes, except on a draft the assistant created and nobody else touched

content_set_translation

Writes one language's title, body, or button label by hand, to fix a wording or supply a translation. Posts, banners, and modals only.

Yes, except on a draft the assistant created and nobody else touched

content_delete_translation

Removes one language, so end users with that language see the base copy.

Yes

content_delete_experience

Deletes a draft, or a published experience or post, together with what it collected (survey responses, comments, reactions). It does not archive and cannot be undone. Deleting a published item needs the delete permission. The preview offers pausing instead when that is enough.

Yes

Teach My Jimo Agent

Tool
What it does
Asks to confirm?

agent_save_custom_answer

Saves a curated question and answer pair. Live for end users within minutes. Saving the same question again updates its answer.

Yes

agent_add_knowledge_source

Imports up to 10 documents per call from text the assistant already holds. Re-importing with the same document id replaces the old version.

Yes

agent_add_website_source

Trains on a help center or docs site from its sitemap (same host, under that address, without following links), or on an exact list of pages. The preview shows the pages found, up to 500, and the existing website sources that already read some of them, before anything trains.

Yes

agent_add_zendesk_source

Trains on the connected Zendesk help center, all published articles (up to 500) or a selection. If Zendesk is not connected, it returns the dashboard link where an admin connects it.

Yes

agent_refresh_knowledge_source

Re-crawls an existing URL source now instead of waiting for the schedule.

No

agent_delete_knowledge_source

Removes a custom answer, an imported document, a website, a Zendesk help center, or an uploaded file. A source that is still training cannot be deleted.

Yes

Build and Run My Jimo Agent

Tool
What it does
Asks to confirm?

agent_update_settings

Instructions, language, attributes the agent may see, launcher targeting, devices, segments, accent and theme, escalation, and how often websites are re-read. Left-out settings stay as they are. Does not switch the launcher on or off.

Yes

agent_set_launcher_state

Puts the launcher live or pauses it. The preview lists what is still missing.

Yes, unless it is already in that state

agent_create_read_all_pages

Up to 10 Read all screens from a name, a description in users' words, and URL rules. No snippet needed to create them, they take effect once the Jimo snippet runs on the site. Each one comes back with a screenshot link. If one page is refused, the whole batch is refused with the reason for each.

Yes

agent_update_page

Name, description, rules, environments. Also the step after a scan, to cover every record of the screen.

Yes

agent_delete_page

Deletes a page and every skill on it. Needs Delete pages and skills.

Yes

agent_set_page_suggestions

The ordered suggested questions on a page, at most four active. A suggestion can start a skill. Suggestions left out of the call are deleted.

Yes

agent_start_page_scan

A dashboard link that opens the scanner. Writes nothing itself: saving the scan in the dashboard adds the page, replaces its scan, or converts it to the other mode, and says which first.

No

agent_create_skills

Up to 10 skills, always created inactive. If one skill is refused, the whole batch is refused with the reason for each.

No

agent_update_skill

Name, description, instructions, type, or move to another page. Live users get the new version within about 30 seconds.

Yes when the skill is live. An inactive skill is updated directly.

agent_set_skill_state

Activates or deactivates up to 20 skills.

Yes, unless nothing would change

agent_delete_skill

Deletes a skill. Deactivating keeps it. Needs Delete pages and skills.

Yes

Deleting a page or a skill also turns off the suggestions that started it, so the launcher stops offering a skill that is gone.

Next Steps

Last updated