Quickstart - Neo Agent

This walks you from zero to a working API call in a couple of minutes.

Create an API key

In the dashboard, open Roles & Access → API Keys, click Create API key, and copy the key — it’s shown only once. See Authentication for the details.

Make your first request

List your agents. Swap in the key you just copied:

curl https://api.neoagent.io/public-api/agents \
  -H "Authorization: Bearer neo_sk_prod_AbCdEf0123456789AbCdEf01"

Read the response

A successful response wraps the result in the standard envelope — your data in data, request metadata and pagination in meta:

{
  "data": [
    {
      "agent_id": "1042",
      "agent_name": "Ticket Triage",
      "autonomy_type": "AGENTIC",
      "enabled": true
    }
  ],
  "meta": {
    "request_id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "pagination": { "has_more": false, "next_cursor": null }
  }
}

Every list response carries meta.request_id (quote it if you contact support) and meta.pagination.

Paginate through a list

List endpoints return up to page_size items (default 50, max 200). When meta.pagination.has_more is true, pass the next_cursor back as the cursor query parameter to fetch the next page:

curl "https://api.neoagent.io/public-api/agents?page_size=100&cursor=eyJpZCI6MTA0Mn0" \
  -H "Authorization: Bearer neo_sk_prod_AbCdEf0123456789AbCdEf01"

Keep following next_cursor until has_more is false.

Explore the endpoints

The full, always-current API reference — every endpoint with its parameters, request and response schemas, and a built-in request console — lives under Endpoints in the sidebar. A few common starting points:

Resource	Endpoint
List your agents	`GET /public-api/agents`
Inspect one agent	`GET /public-api/agents/{agent_id}`
Run an agent now	`POST /public-api/agents/{agent_id}/run-now`
List executions	`GET /public-api/executions`
Read credit usage	`GET /public-api/billing/usage`

Generating a client or SDK? The full OpenAPI 3.1 spec is at https://api.neoagent.io/public-api/openapi.json — fetch it once for tooling (it’s ~440 KB), not per request.

What’s next

Authentication

Key creation, rotation, revocation, and best practices.

Errors

The error envelope and what each status means.

Rate limits

How much you can call, and the headers that tell you.

Neo API agent tool

Let an agent call this same API from inside a workflow.

​Paginate through a list

​Explore the endpoints

​What’s next