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

# Neo API

> Let the agent read and configure Neo itself through Neo's public API

The Neo API tool gives a Neo Agent access to Neo's own public API (`/public-api/*`). Use it for "meta" automations — agents that report on other agents, reconcile configuration, kick off other workflows, manage technician-in-the-loop requests, or escalate to the Neo team.

<Info>
  This is an opt-in tool — enable **Neo API** in the workflow's tool list. Access is scoped by permission groups, the same way the PSA, RMM, and documentation API tools work. Want to call the API from your own code rather than from an agent? See the [public API documentation](/developers/introduction). The full OpenAPI spec is also served at `/public-api/openapi.json`.
</Info>

## What It Does

* Read and configure **agents** (workflows) — list, inspect, enable/disable, update settings
* Browse Neo's curated **templates** library — starting points for new agents
* Query **executions** and **event history** — what ran, when, and what it did
* Fetch **artifacts** produced by an execution — markdown notes inline, sandbox-file downloads via short-lived URLs
* Inspect **callbacks / triggers** — see why a workflow did or didn't match an event
* Manage **technician-in-the-loop** requests — list pending approvals, see decisions
* Look up **RMM script runs** the agent has launched
* Read **settings**, **end companies**, and **integrations** configuration
* Pull **observability**, **performance** rollups, and **billing/credits** data — including end-user (white-label) Teams bot **active-user (MAU)** usage and its monthly charge
* Trigger and read **Insights** ROI analyses
* View **Phone Agent** numbers and call history
* Read **chat sessions**
* Escalate an issue to the **Neo team**

## Permission Groups

Like the other API-backed tools, Neo API access is split into permission groups, each set to **Disabled**, **Read Only**, or **Read / Write** — so you can give an agent read access to executions and analytics without letting it reconfigure other agents, for example.

## Safety Controls

| Control                                       | Behavior                                                                           |
| --------------------------------------------- | ---------------------------------------------------------------------------------- |
| **Opt-in**                                    | Off unless you enable it on the workflow                                           |
| **Permission groups**                         | Scope exactly which parts of the API the agent can touch, and at what access level |
| **Technician-in-the-Loop**                    | Require approval before configuration writes                                       |
| **Test mode**                                 | When test mode is on, the agent plans writes but doesn't execute them              |
| **Same auth & rate limits as any API client** | Calls go through Neo's public API auth and per-tenant rate limiting                |

## How to Configure

<Steps>
  <Step title="Enable the Neo API tool">
    Add **Neo API** to the workflow's tool list.
  </Step>

  <Step title="Set permission groups">
    Choose which parts of the API the agent can read or write.
  </Step>

  <Step title="Set approval requirements">
    Decide whether configuration writes require technician approval.
  </Step>
</Steps>

<Tip>
  Start with **Read Only** — most "meta" agents (status digests, drift checks, "did workflow X run today?") never need to write anything.
</Tip>