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}`
Edit an agent’s instructions in place	`PATCH /public-api/agents/{agent_id}` with `agent_settings_edits.custom_instructions`
Change one triage field’s instructions	`PATCH /public-api/agents/{agent_id}` with `fields_to_triage_edits` on the `TRIAGE_TICKET` / `TRIAGE_TIME_ENTRY` action — keyed by `field_name` (a custom field also needs `custom_field_name`), so the other triage fields stay untouched
Remove one triage field	Same `fields_to_triage_edits` entry with `"remove": true` — no need to resend the whole array. Removing a field that isn’t configured, or the last remaining field, returns `400`
Run an agent now	`POST /public-api/agents/{agent_id}/run-now`
List executions	`GET /public-api/executions`
Every action your agents took (Audit Log)	`GET /public-api/audit-log/tool-calls?search={ticket number}`
Read credit usage	`GET /public-api/billing/usage`
Credits per ticket for a period	`GET /public-api/billing/usage-by-ticket?since={ISO 8601}&until={ISO 8601}`
What a credit costs you	`GET /public-api/billing/subscription` → `credit_unit_price`
A plan change already scheduled	`GET /public-api/billing/subscription` → `scheduled_change` (date, plan, monthly credits and price)
Time saved, its value and Neo’s cost	`GET /public-api/performance/summary?from={ISO 8601}&to={ISO 8601}` → `credits_cost`, `labor_value_saved`, `fx`
Read or set your cost of technician time	`GET` / `PUT /public-api/settings/value`

Money fields

Credit and hours figures carry what they are worth, as the dashboard shows them:

credit_unit_price (amount_minor per credit in your billing currency, and its source) on /billing/subscription. credits_cost (amount_minor, currency) beside credits on /billing/usage, each /billing/usage-by-agent row, /performance/summary and each /performance/workflows row. Both are null when no price is known, such as on a trial; treat that as unknown, not free. A past month is priced at today’s rate.
labor_value_saved (amount, currency, hourly_cost, source) on /performance/summary and each /performance/workflows row: hours saved times your cost per technician hour. source is SET_BY_USER for your own rate and DEFAULT_BY_REGION for the typical rate of your region. Hours saved are estimates, and so is their value.
fx converts credits_cost into the currency of labor_value_saved when the two differ, at the European Central Bank rate of as_of; null otherwise.
estimated_manual_minutes on each execution: the technician minutes a successful run is estimated to have saved, null for any other status.
PUT /public-api/settings/value takes {"hourly_cost": 65, "currency": "usd"} (usd, eur, gbp, cad or aud, above 0 and at most 10,000). Admins and owners only; a key with no acting user counts as the tenant.

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

​Money fields

​What’s next