> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Agents

> Class reference for Agents

> Defined in the [**agents**](../modules/agents) module.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#8B0000', 'primaryTextColor': '#fff', 'primaryBorderColor': '#710101', 'lineColor': '#189AB4', 'secondaryColor': '#189AB4', 'tertiaryColor': '#fff' }}}%%

graph LR
    input["Input Data"] --> agent["Agent: Agents"]
    agent --> output["Output Result"]
    style agent fill:#8B0000,color:#fff
    style input fill:#8B0000,color:#fff
    style output fill:#8B0000,color:#fff
```

## Constructor

<ParamField query="agents" type="Any" required={true}>
  No description available.
</ParamField>

<ParamField query="tasks" type="Any" required={false}>
  No description available.
</ParamField>

<ParamField query="process" type="Any" required={false} default="'sequential'">
  No description available.
</ParamField>

<ParamField query="manager_llm" type="Any" required={false}>
  No description available.
</ParamField>

<ParamField query="name" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="variables" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="memory" type="Optional" required={false} default="False">
  No description available.
</ParamField>

<ParamField query="planning" type="Optional" required={false} default="False">
  No description available.
</ParamField>

<ParamField query="context" type="Optional" required={false} default="False">
  No description available.
</ParamField>

<ParamField query="output" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="execution" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="hooks" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="autonomy" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="knowledge" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="guardrails" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="web" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="reflection" type="Optional" required={false}>
  No description available.
</ParamField>

<ParamField query="caching" type="Optional" required={false}>
  No description available.
</ParamField>

## Methods

<CardGroup cols={2}>
  <Card title="add_task()" icon="function" href="../functions/Agents-add_task">
    Instance method.
  </Card>

  <Card title="clean_json_output()" icon="function" href="../functions/Agents-clean_json_output">
    Instance method.
  </Card>

  <Card title="context_manager()" icon="function" href="../functions/Agents-context_manager">
    ContextManager instance for unified context management across all agents.
  </Card>

  <Card title="default_completion_checker()" icon="function" href="../functions/Agents-default_completion_checker">
    Instance method.
  </Card>

  <Card title="aexecute_task()" icon="function" href="../functions/Agents-aexecute_task">
    Async version of execute\_task method
  </Card>

  <Card title="arun_task()" icon="function" href="../functions/Agents-arun_task">
    Async version of run\_task method
  </Card>

  <Card title="arun_all_tasks()" icon="function" href="../functions/Agents-arun_all_tasks">
    Async version of run\_all\_tasks method
  </Card>

  <Card title="astart()" icon="function" href="../functions/Agents-astart">
    Async version of start method.
  </Card>

  <Card title="save_output_to_file()" icon="function" href="../functions/Agents-save_output_to_file">
    Instance method.
  </Card>

  <Card title="execute_task()" icon="function" href="../functions/Agents-execute_task">
    Synchronous version of execute\_task method
  </Card>

  <Card title="run_task()" icon="function" href="../functions/Agents-run_task">
    Synchronous version of run\_task method
  </Card>

  <Card title="run_all_tasks()" icon="function" href="../functions/Agents-run_all_tasks">
    Synchronous version of run\_all\_tasks method
  </Card>

  <Card title="get_task_status()" icon="function" href="../functions/Agents-get_task_status">
    Instance method.
  </Card>

  <Card title="get_all_tasks_status()" icon="function" href="../functions/Agents-get_all_tasks_status">
    Instance method.
  </Card>

  <Card title="get_task_result()" icon="function" href="../functions/Agents-get_task_result">
    Instance method.
  </Card>

  <Card title="get_task_details()" icon="function" href="../functions/Agents-get_task_details">
    Instance method.
  </Card>

  <Card title="get_agent_details()" icon="function" href="../functions/Agents-get_agent_details">
    Instance method.
  </Card>

  <Card title="start()" icon="function" href="../functions/Agents-start">
    Start agent execution with verbose output (beginner-friendly).
  </Card>

  <Card title="run()" icon="function" href="../functions/Agents-run">
    Run agents silently (production use).
  </Card>

  <Card title="set_state()" icon="function" href="../functions/Agents-set_state">
    Set a state value
  </Card>

  <Card title="get_state()" icon="function" href="../functions/Agents-get_state">
    Get a state value
  </Card>

  <Card title="update_state()" icon="function" href="../functions/Agents-update_state">
    Update multiple state values
  </Card>

  <Card title="clear_state()" icon="function" href="../functions/Agents-clear_state">
    Clear all state values
  </Card>

  <Card title="has_state()" icon="function" href="../functions/Agents-has_state">
    Check if a state key exists
  </Card>

  <Card title="get_all_state()" icon="function" href="../functions/Agents-get_all_state">
    Get a copy of the entire state dictionary
  </Card>

  <Card title="delete_state()" icon="function" href="../functions/Agents-delete_state">
    Delete a state key if it exists. Returns True if deleted, False if key didn't exist.
  </Card>

  <Card title="increment_state()" icon="function" href="../functions/Agents-increment_state">
    Increment a numeric state value. Creates the key with default if it doesn't exist.
  </Card>

  <Card title="append_to_state()" icon="function" href="../functions/Agents-append_to_state">
    Append a value to a list state. Creates the list if it doesn't exist.
  </Card>

  <Card title="save_session_state()" icon="function" href="../functions/Agents-save_session_state">
    Save current state to memory for session persistence
  </Card>

  <Card title="restore_session_state()" icon="function" href="../functions/Agents-restore_session_state">
    Restore state from memory for session persistence. Returns True if restored.
  </Card>

  <Card title="get_token_usage_summary()" icon="function" href="../functions/Agents-get_token_usage_summary">
    Get a summary of token usage across all agents and tasks.
  </Card>

  <Card title="get_detailed_token_report()" icon="function" href="../functions/Agents-get_detailed_token_report">
    Get a detailed token usage report.
  </Card>

  <Card title="display_token_usage()" icon="function" href="../functions/Agents-display_token_usage">
    Display token usage in a formatted table.
  </Card>

  <Card title="launch()" icon="function" href="../functions/Agents-launch">
    Launch all agents as a single API endpoint (HTTP) or an MCP server.
  </Card>

  <Card title="current_plan()" icon="function" href="../functions/Agents-current_plan">
    Get the current plan.
  </Card>

  <Card title="todo_list()" icon="function" href="../functions/Agents-todo_list">
    Get the current todo list.
  </Card>

  <Card title="get_plan_markdown()" icon="function" href="../functions/Agents-get_plan_markdown">
    Get the current plan as markdown.
  </Card>

  <Card title="get_todo_markdown()" icon="function" href="../functions/Agents-get_todo_markdown">
    Get the current todo list as markdown.
  </Card>

  <Card title="update_plan_step_status()" icon="function" href="../functions/Agents-update_plan_step_status">
    Update the status of a plan step.
  </Card>
</CardGroup>
