DOCSEARCHbyAlgolia
Submit Docs

xMagic Documentation

website·Indexed 32 days ago

https://docs.xmagic.ai

A platform for designing, testing, and deploying AI agents capable of answering questions, using tools, and executing workflows. Documentation covers Agent and Subagent configuration, xMagic Studio, the Drive API for knowledge bases, and a variety of built-in tools including Browser, Shell, and JSON Converter. It also provides guides on MCP (Model Context Protocol) custom tools, SharePoint integration, and managing production conversations via Threads.

Tokens
28.6K
Snippets
57
Records
264
Agent score
55%

What's inside xMagic

  1. Overview of xMagic Drive

    Drive is a shared repository of documents and links that serves as the retrieval context for agents and subagents. It can be accessed via the Sidebar → Drive. The landing page provides sections for Recently opened folders, Shared with me (teammate shares), Workspace folders, and a Search function for folder/document lookup.

  2. Overview of Threads for production monitoring

    Threads is a production conversation inbox for external users used to monitor quality, identify intent patterns, and detect failure modes. It allows teams to review real user interactions, investigate bad answers or escalations, audit channel-specific behavior, and identify gaps in routing, prompts, or tools. Access it via Agent → Threads.

  3. Overview of the Composer interface

    The Composer is the central hub for designing, testing, and deploying agent behavior. It is accessible via the Sidebar → Composer or by switching to the Composer view within any agent. The layout consists of a Header Bar, a Left Panel (60%) containing the Playground for live chat preview, and a collapsible Right Panel (30%) for configuration views.

  4. Overview of xMagic AI Agent Platform

    xMagic is a platform for building private, autonomous AI agents designed to learn workflows and handle end-to-end tasks. These agents integrate across communication channels (calls, chat, email) and internal systems to provide a unified intelligent interface. xMagic supports self-hosting in a private cloud or data center, providing full control over data and model usage. Agents are designed to adapt to specific processes, language, and preferences over time to reduce manual intervention and oversight.

  5. Overview of xMagic Custom Tools

    Custom Tools allow xMagic agents to extend their capabilities by connecting to external MCP (Model Context Protocol) servers. These integrations enable Subagents to call external APIs, parse or transform data, and interact with third-party services such as CRMs, databases, and notification systems.

  6. Overview of the Worklist asynchronous operations layer

    The Worklist serves as the asynchronous operations layer for long-running and scheduled tasks. It allows users to run background tasks outside of live chat turns, schedule recurring operations, monitor task status/outputs, and manage failed or completed tasks via rerunning or archiving. Access the Worklist by navigating to Agent → Worklist (when enabled).

  7. Best practices for Agent architecture

    To optimize Agent performance and maintainability:

    • Keep the Agent's purpose explicit and narrow.
    • Use Subagents for specialization, but avoid over-fragmentation.
    • Attach only the minimal required tools to each Subagent.
    • Always pair deployments with post-launch monitoring.

  8. Interpret xMagic live_update tool data

    When receiving a live_update event, the data object provides details about tool execution. For tool_call_result events, the preview object describes the output.

    data Object Fields:

    • tool_name: Internal name of the called tool.
    • preview: Present on tool_call_result events.

    preview Object Fields:

    • title: Human-readable label for the output.
    • content: Rendered content of the result.
    • content_type: Format of the content (e.g., text, markdown, json, html, image).
    • status: Either completed or error.

  9. Use the Browser tool for targeted web extraction

    The Browser tool allows Subagents to navigate and read page content when answers require targeted web extraction. It is specifically intended for:

    • Extracting content from websites
    • Verifying information on public pages
    • Performing dynamic lookups from known URLs.

  10. Understand and access Agent Artifacts

    Artifacts represent the generated-output layer of an Agent, consisting of documents, structured files, and reports produced by Subagents and tools. They persist across sessions and versions, providing a full audit trail when combined with Chat History. All Subagent outputs are automatically captured as Artifacts.
    Navigation: Agent → Artifacts

  11. Configure tools for a Subagent

    Tools act as the action layer of the Agent architecture, enabling Subagents to perform tasks beyond conversational responses. Tools are configured on a per-Subagent basis rather than globally to minimize tool sprawl and reduce the likelihood of incorrect tool calls.
    Composer → Manual mode → select Subagent → Tools

  12. Understand xMagic Workspace architecture

    A Workspace is the top-level container in xMagic. It serves as a single source of truth where Agents, Jobs, Knowledge Bases, Tools, billing settings, and member privileges are stored. Resources like phone numbers, Custom Tools, and Global Knowledge folders are configured at the Workspace level and reused across its Agents. Access the Workspace panel by navigating to Settings → Workspace in the top-left profile menu.