Update an intent
curl --request PUT \
--url https://api.neoagent.io/public-api/intents/{intent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agent_ids": [],
"ask_for": "",
"description": "",
"enabled": true,
"end_company_ids": [],
"fields": [],
"surfaces": []
}
'import requests
url = "https://api.neoagent.io/public-api/intents/{intent_id}"
payload = {
"name": "<string>",
"agent_ids": [],
"ask_for": "",
"description": "",
"enabled": True,
"end_company_ids": [],
"fields": [],
"surfaces": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agent_ids: [],
ask_for: '',
description: '',
enabled: true,
end_company_ids: [],
fields: [],
surfaces: []
})
};
fetch('https://api.neoagent.io/public-api/intents/{intent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.neoagent.io/public-api/intents/{intent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'agent_ids' => [
],
'ask_for' => '',
'description' => '',
'enabled' => true,
'end_company_ids' => [
],
'fields' => [
],
'surfaces' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/intents/{intent_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.neoagent.io/public-api/intents/{intent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/intents/{intent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_ids": [
123
],
"ask_for": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"enabled": true,
"end_company_ids": [
"<string>"
],
"fields": [
{
"key": "<string>",
"label": "<string>",
"choices": [],
"help": "<string>",
"placeholder": "<string>",
"required": false
}
],
"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>"
]
}
}{
"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"
}
}Intents
Update an intent
Full replace of every editable field. Disabling is always allowed; re-enabling re-checks the 15-per-agent cap.
PUT
/
public-api
/
intents
/
{intent_id}
Update an intent
curl --request PUT \
--url https://api.neoagent.io/public-api/intents/{intent_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agent_ids": [],
"ask_for": "",
"description": "",
"enabled": true,
"end_company_ids": [],
"fields": [],
"surfaces": []
}
'import requests
url = "https://api.neoagent.io/public-api/intents/{intent_id}"
payload = {
"name": "<string>",
"agent_ids": [],
"ask_for": "",
"description": "",
"enabled": True,
"end_company_ids": [],
"fields": [],
"surfaces": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agent_ids: [],
ask_for: '',
description: '',
enabled: true,
end_company_ids: [],
fields: [],
surfaces: []
})
};
fetch('https://api.neoagent.io/public-api/intents/{intent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.neoagent.io/public-api/intents/{intent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'agent_ids' => [
],
'ask_for' => '',
'description' => '',
'enabled' => true,
'end_company_ids' => [
],
'fields' => [
],
'surfaces' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/intents/{intent_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.neoagent.io/public-api/intents/{intent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/intents/{intent_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agent_ids\": [],\n \"ask_for\": \"\",\n \"description\": \"\",\n \"enabled\": true,\n \"end_company_ids\": [],\n \"fields\": [],\n \"surfaces\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_ids": [
123
],
"ask_for": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"enabled": true,
"end_company_ids": [
"<string>"
],
"fields": [
{
"key": "<string>",
"label": "<string>",
"choices": [],
"help": "<string>",
"placeholder": "<string>",
"required": false
}
],
"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>"
]
}
}{
"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: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).
Path Parameters
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.
fields is the typed form schema: non-empty makes the intent structured, so the
end-user chat renders it as a form instead of asking in prose. Empty (the default) keeps the
intent on ask_for, exactly as before — and because a PUT replaces everything, omitting fields
on an update of a structured intent clears its form.
Show child attributes
Show child attributes
Which kind of agent an intent applies to: END_USER_CHAT (a branded end-user chat bot), MSP_CHAT (an internal chat agent, used by the MSP's own people) or TRIGGERED (a ticket-triggered agent).
Available options:
END_USER_CHAT, TRIGGERED, MSP_CHAT Response
Success.
A curated request type: a menu name/description, its intake (the free-text ask_for script
and/or the typed fields form schema), the surfaces it runs on, and the agents/companies it
applies to (empty = all).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I