AutoAgent Documentation

repository·main·Indexed 27 days ago

https://github.com/hkuds/autoagent

A fully-automated, zero-code LLM agent framework for building, customizing, and deploying complex agent systems and workflows using natural language. It features three primary modes: user mode for deep research, an agent editor for creating tools and agents, and a workflow editor for designing agent workflows. AutoAgent supports multiple LLM providers via Litellm and provides a CLI and API for executing agents and workflows.

Tokens
4.1K
Snippets
12
Records
37
Agent score
95%

What's inside AutoAgent

  1. Overview of AutoAgent features

    main

    AutoAgent is a fully-automated, self-developing framework designed to create and deploy LLM agents using only natural language. It is optimized for high performance on the GAIA benchmark and supports building tools, agents, and workflows without manual coding.

    Key capabilities include:

    • Agentic-RAG: Includes a native self-managing vector database.
    • Universal LLM Support: Integrates with OpenAI, Anthropic, Deepseek, vLLM, Grok, Huggingface, and more.
    • Flexible Interaction Modes: Supports both function-calling and ReAct interaction patterns.
    • Low-Code Creation: Uses natural language to generate ready-to-use agents and workflows.
  2. Overview of AutoAgent Modes

    main

    AutoAgent provides three primary modes for interacting with LLM agents:

    1. user mode (Deep Research Agents): A ready-to-use multi-agent system designed for information retrieval, complex analytical tasks, and report generation. It is compatible with various LLMs (e.g., Deepseek-R1, Grok, Gemini) and supports file uploads.
    2. agent editor (Agent Creation without Workflow): Allows you to create tools and agents using only natural language. The process involves inputting requirements, automated profiling, outputting agent profiles, and creating tools.
    3. workflow editor (Agent Creation with Workflow): Enables the creation of agent workflows via natural language descriptions. Note that this mode does not currently support tool creation.
  3. Obtain and export cookie JSON files for web automation

    main

    To allow AutoAgent to maintain authenticated sessions and skip repeated logins, you can provide cookie JSON files.

    1. Use the Google Chrome extension "Export cookie JSON file for Puppeteer".
    2. Navigate to the target website and log in manually.
    3. Use the extension to export the cookies and save the resulting .json file into the autoagent/environment/cookie_json/ folder.
  4. Use AutoAgent in `user mode` for Deep Research

    main
    Use user mode to access a high-performance multi-agent system for research tasks. It functions as an AI research assistant for information retrieval and complex analysis. It is designed as an open-source, cost-effective alternative to subscription-based deep research tools and supports multiple LLM providers.
  5. Deploy the website

    main

    You can deploy the website using two different methods:

    1. Using SSH: Set the USE_SSH environment variable to true.

    2. Using GitHub Pages (Non-SSH): Provide your GitHub username via the GIT_USER environment variable. This will build the website and push it to the gh-pages branch.

  6. Create agents using `agent editor` mode

    main

    Use agent editor to build custom agents and tools through natural language conversation. The workflow follows these steps:

    1. Input Requirements: Describe the kind of agent you want to create.
    2. Profiling: The system performs automated agent profiling.
    3. Profiles: Review the generated agent profiles.
    4. Tool Creation: Create the specific tools required for the agent.
    5. Task Definition (Optional): Input specific tasks you want the agent to complete.
    6. Finalize: Create the agent and proceed to the next step.
  7. Add third-party Tool Platform API keys

    main

    To create tools from third-party platforms (like RapidAPI), subscribe to the tools on their platform and then run the process_tool_docs.py script to add your API keys.

    python process_tool_docs.py
  8. Create workflows using `workflow editor` mode

    main

    Use workflow editor to design agent workflows using natural language. The workflow follows these steps:

    1. Input Requirements: Describe the kind of workflow you want to create.
    2. Profiling: The system performs automated workflow profiling.
    3. Profiles: Review the generated workflow profiles.
    4. Task Definition (Optional): Input specific tasks you want the workflow to complete.
    5. Finalize: Create the workflow and proceed to the next step.

    Note: This mode does not currently support tool creation.

  9. Install AutoAgent

    main

    You can install AutoAgent by cloning the repository and installing it in editable mode using pip. Alternatively, you can use Docker, which will automatically pull the appropriate pre-built image for your architecture.

    git clone https://github.com/HKUDS/AutoAgent.git
    cd AutoAgent
    pip install -e .