Skip to main content
The Neo public API lets you do from your own code what you’d otherwise do in the dashboard: list and configure agents, read execution history and analytics, pull billing and usage, manage technician approvals, and more. It’s the same API the Neo dashboard, the Teams bot, and partner integrations are built on.

Authentication

Create an API key and authenticate your requests.

Quickstart

Make your first request in a couple of minutes.

Endpoints

Browse every endpoint with live request and response schemas.

Errors & rate limits

Error codes, the response envelope, and rate limits.

​
Base URL

All requests go to a single global host. Neo routes your request to the right region (US, UK, EU, or AU) under the hood, based on your tenant — there are no per-region URLs. 
https://api.neoagent.io

​
The response envelope

Every response uses the same envelope, so your code can handle success and failure consistently. Success — the payload is in data, with request metadata (and pagination, for lists) in meta: 
{
  "data": { "...": "..." },
  "meta": { "request_id": "a1b2c3d4-...", "pagination": { "has_more": false, "next_cursor": null } }
}
Error — a stable code, a human-readable message, and a request_id to quote to support: 
{
  "error": { "code": "FORBIDDEN", "message": "API-key management requires admin role." },
  "meta": { "request_id": "a1b2c3d4-..." }
}
See Errors for the full list of codes and statuses.

​
Finding exact paths

Pick the source that matches what you’re doing — you shouldn’t have to guess a path:
You’re…Use
Reaching for a common endpointThe quickstart endpoint table — method and path for the everyday ones.
Looking up a single endpointIts page under Endpoints in the sidebar — exact method, path, parameters, and response schemas, with a request console. Each page is small, so this is the lightweight lookup (and the right one for an AI agent making an ad-hoc call).
Generating a client or SDKThe full OpenAPI 3.1 spec at https://api.neoagent.io/public-api/openapi.json — the complete contract. It’s large (~440 KB), so fetch it once for tooling rather than per request.

​
”Agent” means workflow

In the API, agent is what the dashboard and the rest of these docs call a workflow or agent — the /agents endpoints cover triggered workflows, scheduled agents, and chat agents alike. The public name is agent_id.
The API is additive and versioned. New fields and endpoints can appear at any time, so write your client to ignore unknown fields. Breaking changes ship under a new version path with an overlap window — they never change an existing response shape underneath you.

​
What’s next

Get your API key

Create a key in the dashboard and start authenticating.

Make your first call

A copy-paste request that lists your agents.