list_entities

Lists entities of a given type for discovery and reference. Use the IDs returned here when constructing filters in get_ada_metric or get_conversations, or when targeting specific channels, topics, or variables in prompts.

Supported entity types

• channels — All communication channels configured for the AI Agent (native and custom).
• topics — Generated topics and categories. Use topic IDs with the TOPICS filter in get_ada_metric or get_conversations.
• variables — Conversation variables across scopes (global, meta, auto_capture). Use variable names with the VARIABLE filter in get_ada_metric or get_conversations.
• playbooks — AI Agent playbooks. Returns a summary by default (ID, name, description, version, active status). Pass entity_id to get full detail including steps and structure.
• handoffs — Handoff responses configured for the AI Agent, including active status.

Example prompts

• “What channels are configured on our Agent?”
• “List all topics configured on our Agent.”
• “List all autocapture variables so I can filter conversations by one of them.”
• “Show me the full details of playbook abc123.”
• “What handoff responses are available?”

Parameters

Response

Returns the list of entities for the chosen type. Fields vary by entity_type and detail:

• channels — channel ID, name, type, modality, and description.
• topics — topic ID, name, category, and conversation volume (when available).
• variables — variable name, scope (global, meta, auto_capture), type, and description (when available).
• playbooks — playbook ID, name, description, version, and active status. When fetched by entity_id, includes full step structure.
• handoffs — handoff ID, name, description, and active status.