Skip to main content
POST
/
public-api
/
intents
Create an intent
curl --request POST \
  --url https://api.neoagent.io/public-api/intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_ids": [],
  "ask_for": "",
  "description": "",
  "enabled": true,
  "end_company_ids": [],
  "surfaces": []
}
'
{
  "data": {
    "agent_ids": [
      123
    ],
    "ask_for": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "enabled": true,
    "end_company_ids": [
      "<string>"
    ],
    "id": "<string>",
    "name": "<string>",
    "surfaces": [],
    "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

Create/replace payload. A PUT replaces every editable field, so name is required and the rest default. agent_ids/end_company_ids empty = applies to all agents of the matching surface / all companies. surfaces declares which agent kinds the intent applies to (at least one; validated in the service). An enabled intent is capped at 15 per applicable agent.

​
name
string
required
​
agent_ids
integer[]
​
ask_for
string
default:""
​
description
string
default:""
​
enabled
boolean
default:true
​
end_company_ids
string[]
​
surfaces
enum<string>[]

Which kind of agent an intent applies to: END_USER_CHAT (a branded end-user chat bot) or TRIGGERED (a ticket-triggered agent).

Available options:
END_USER_CHAT,
TRIGGERED

Response

Success.

​
data
PublicIntent · object
required

A curated request type: a menu name/description, an intake question script (ask_for), the surfaces it runs on, and the agents/companies it applies to (empty = all).

​
meta
object
required