curl --request POST \
  --url https://api.neoagent.io/public-api/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_settings": {
    "custom_instructions": "Triage incoming tickets — categorise, set priority, post a summary note."
  },
  "autonomy_type": "AGENTIC",
  "callback_settings": {
    "target_changes": [
      {
        "change_type": "CREATE"
      }
    ]
  },
  "entity_type": "ticket",
  "name": "Triage agent",
  "ticket_conditions": {
    "conditions": {
      "combinator": "and",
      "rules": []
    },
    "custom_field_conditions": null,
    "workload_conditions": null
  },
  "toolbox": {
    "tool_settings_by_type": {}
  },
  "trigger_type": "TRIGGERED"
}
'

{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Agents

Create an agent

Creates an agent/workflow for the caller’s tenant. The body is a discriminated union on autonomy_type (CHAINED_ACTIONS / AGENTIC / CONVERSATIONAL). The contract is intent-shaped: callers describe entity_type + ticket_conditions / time_entry_conditions, and the server constructs the canonical actions array (prepending FIND_ENTITIES for CHAINED_ACTIONS / AGENTIC; the trailing AGENTIC action for AGENTIC; an empty list for CONVERSATIONAL). For CHAINED_ACTIONS, actions is the pipeline AFTER the auto-prepended FIND_ENTITIES — including FIND_ENTITIES yourself returns 400. CONVERSATIONAL agents accept audience (MSP | END_USER, default MSP) — set END_USER to provision a user-facing chat agent that can bind an END_USER channel; it must then hold only END_USER tools. Audience is set at create and is immutable. They also accept access (ALL_USERS | ADMINS_ONLY | SPECIFIC_USERS, default ALL_USERS), controlling which of the MSP’s own users may message the agent (set in the dashboard thereafter). created_by_user is derived from the authenticated identity — not accepted in the body. Toolboxes that supply external-API credentials are rejected (400 validation_error); configure those in the dashboard. Discover the shapes via the /schemas/* endpoints.

POST

public-api

agents

curl --request POST \
  --url https://api.neoagent.io/public-api/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_settings": {
    "custom_instructions": "Triage incoming tickets — categorise, set priority, post a summary note."
  },
  "autonomy_type": "AGENTIC",
  "callback_settings": {
    "target_changes": [
      {
        "change_type": "CREATE"
      }
    ]
  },
  "entity_type": "ticket",
  "name": "Triage agent",
  "ticket_conditions": {
    "conditions": {
      "combinator": "and",
      "rules": []
    },
    "custom_field_conditions": null,
    "workload_conditions": null
  },
  "toolbox": {
    "tool_settings_by_type": {}
  },
  "trigger_type": "TRIGGERED"
}
'

{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Body

application/json

CreateChainedActionsAgent
CreateAgenticAgent
CreateConversationalAgent

A fixed-pipeline workflow — the server runs FIND_ENTITIES (built from entity_type and the conditions below) followed by actions in order. Triggered by a PSA event (trigger_type=TRIGGERED + callback_settings) or on a schedule (trigger_type=SCHEDULED

schedule).

actions

Actions · object[]

required

name

string

required

trigger_type

enum<string>

required

Available options:

SCHEDULED,

TRIGGERED,

NONE

autonomy_type

string

default:CHAINED_ACTIONS

Allowed value: "CHAINED_ACTIONS"

callback_settings

EventMatchSettings · object | null

Show child attributes

description

string | null

entity_type

enum<string>

default:TICKET

Available options:

ticket,

project_ticket,

task,

scheduled_entry,

time_entry,

project,

company,

contact,

resource,

contract,

opportunity,

none,

configuration,

note,

team,

role,

audit_trail,

appointment,

servicecall,

contract_service,

company_location,

product

execution_order

integer | null

group_name

string | null

group_order

integer | null

process_entities_sequentially

boolean

default:false

process_sub_entities_only_once

boolean

default:false

schedule

WorkflowSchedule · object | null

Show child attributes

show_in_psa_pod

boolean | null

state

enum<string>

default:ENABLED

Available options:

ENABLED,

DISABLED,

DELETED

ticket_conditions

PsaTicketConditions · object | null

Trigger/entity filter for TICKET agents — which tickets this agent fires on. Send it at the top level to set or change the filter; the server (re)builds the FIND_ENTITIES action from it (do not put the filter in actions). Use time_entry_conditions instead for TIME_ENTRY agents. Shape: conditions holds a combinator (and/or) and a rules list of leaves (field/operator/value) and/or nested groups (rules + combinator). A rule's position in the tree changes the logic — a company exclusion belongs as a top-level rule under the root and, not nested inside an or, or it only excludes when the other branches also miss.

Show child attributes

time_entry_conditions

PsaConditions · object | null

Trigger/entity filter for TIME_ENTRY agents — the analogue of ticket_conditions. Ignored for TICKET agents.

Show child attributes

Response

Success.

data

Agent · object

required

Lean summary of a workflow row — the per-item shape GET /public-api/agents (list) returns. The single-resource GET /public-api/agents/<id> returns the richer AgentDetail; historical snapshots come back as AgentVersion.

Show child attributes

Get started

Endpoints

Create an agent

Authorizations

Body

Response