To let an assistant use these tools, grant AI agents on the consent screen, or just
Agents under its Fine-tune. The scope is agents.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
Your AI agents and their versions. A version can't be changed once it's created. To change an agent, build a new version with create_agent_version (its model, persona, instructions, and what it uses: context blocks, journeys, presentations, library groups, conduct rules and policies), then promote it with promote_agent_version. Promoting changes what live customers talk to straight away, and so does revert_agent_version, which puts an older version live again: confirm with the user first.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
list_agents
Read List agents
The org's AI agents with their draft and production versions.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_agent
Read Get an agent
One agent with its full version history.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_agents_overview
Read Agents overview
Counts across the agent estate: agents, personas, context blocks, conduct rules, tools, library items, channel deployments and contacts.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_agent_version
Read Get an agent version
One agent version in full: its instructions, model, persona, and everything it uses (context blocks, journeys, presentations, library groups, conduct rules, policies).
Arguments
| Field | Type | Description |
|---|---|---|
| agent_id required | string | |
| version_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_agent
Write Create an agent
Create an agent shell. industry/agent_type/custom_industry are creation-time only (read-only afterwards); configure behaviour by creating a version next.
Arguments
| Field | Type | Description |
|---|---|---|
| name required | string | |
| industry | string | e.g. insurance, financial |
| agent_type | string | Registry key, e.g. insurance_support (see the type registry) |
| custom_industry | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_agent
Write Rename an agent
Rename an agent (its classification can't be changed after it's created).
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| name required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
delete_agent
Write Delete an agent
Delete an agent and its versions. Refused while live deployments depend on it. Irreversible: confirm with the operator first.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
create_agent_version
Write Create an agent version
Build a new draft version of an agent: its model, persona, instructions and what it uses. Each context block is added as it is now; journeys and presentations must belong to the organisation's products; conduct rules are added by id or by template key. The version becomes the agent's draft. Promote it separately with promote_agent_version.
Arguments
| Field | Type | Description |
|---|---|---|
| agent_id required | string | |
| ai_model_id required | string | |
| persona_id | string | Optional: the agent's own persona is used by default. Naming a persona no other agent owns makes it this agent's. |
| intro_text | string | |
| escalation_text | string | |
| closing_text | string | |
| type_instructions | string | |
| quote_form_greeting | string | What the agent says when a chat is opened from a quote form (the website gets intro_text). Blank keeps the AI-written opener about the product. {{first_name}} and other known values fill in; a line naming one that isn't known is left out. |
| quote_form_starters | array of string | Tappable prompts under the quote form greeting (the website shows the site's own). |
| creativity | string |
One of: "creativity_none", "creativity_minimal", "creativity_limited", "creativity_some", "creativity_moderate", "creativity_high", "creativity_maximum"
|
| media_frequency | string |
One of: "media_never", "media_once", "media_moderate", "media_always"
|
| suggested_answers | boolean | On webchat, let the agent offer a few tappable replies under a message. Off by default. |
| context_block_ids | array of string | Ordered |
| insurance_journey_ids | array of string | Ordered |
| presentation_ids | array of string | Ordered |
| library_group_ids | array of string | |
| conduct_rule_ids | array of string | |
| conduct_rule_template_keys | array of string | |
| agent_policy_ids | array of string | Ordered |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
promote_agent_version
Write Promote an agent version
Recompile and promote a version to production: it immediately serves live customer conversations on every channel the agent is deployed to. Confirm with the operator first.
Arguments
| Field | Type | Description |
|---|---|---|
| agent_id required | string | |
| version_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
revert_agent_version
Write Revert to an agent version
Clone an older version's full configuration into a new version and promote it: the rollback path. Goes live immediately; confirm with the operator first.
Arguments
| Field | Type | Description |
|---|---|---|
| agent_id required | string | |
| version_id required | string | The version to restore |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
start_test_conversation
Write Start a test conversation
Open an internal test chat against an agent version (draft by default, or a specific version_id): nothing reaches customers. Then use send_test_message.
Arguments
| Field | Type | Description |
|---|---|---|
| agent_id required | string | |
| version_id | string | Defaults to the draft (or production) version |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
send_test_message
Write Send a test message
Chat with the agent in an internal test conversation and get its real reply (a live LLM call). Refused on customer conversations.
Arguments
| Field | Type | Description |
|---|---|---|
| conversation_id required | string | |
| content required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |