Skip to main content
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>"
    ]
  }
}

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

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
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
show_in_psa_pod
boolean | null
state
enum<string>
default:ENABLED
Available options:
ENABLED,
DISABLED,
DELETED
ticket_conditions
PsaTicketConditions · object
time_entry_conditions
PsaConditions · object

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.

meta
object
required