Start a dashboard from a template
curl --request POST \
--url https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate', 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/dashboards/templates/{template_id}/instantiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"dataset": {
"columns": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"derived": false
}
],
"date_column": "<string>",
"id_column": "<string>",
"pinned_columns": [
"<string>"
]
},
"preview_widgets": [
{
"component": "stat_group",
"id": "<string>",
"layout": {
"h": 123,
"w": 123,
"x": 123,
"y": 123
},
"query": {
"columns": [
"<string>"
],
"filter": [
{
"column": "<string>",
"op": "eq",
"value": null
}
],
"group_by": [
{
"column": "<string>",
"bucket": "day"
}
],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"fn": "count",
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"op": "eq",
"value": null
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
},
"title": "<string>"
}
],
"prompt": "<string>",
"spec": "<string>",
"template": {
"buildable": true,
"category": "<string>",
"client_scoped": true,
"description": "<string>",
"id": 123,
"missing_integrations": [
"<string>"
],
"name": "<string>",
"optional_integrations": [
"<string>"
],
"popular": true,
"required_integrations": [
"<string>"
],
"section": "<string>",
"supported_psas": [
"CONNECTWISE"
],
"tagline": "<string>"
}
},
"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"
}
}Dashboards
Start a dashboard from a template
Stores nothing. Answers the template resolved for this workspace, its dataset, preview_widgets and spec, and prompt: the message that asks the Neo Support chat to build it. A template is a target, not a payload: the builder reads the spec, asks only what it leaves open, writes collect(ctx) for this workspace’s systems and calls POST /dashboards with source_template_id. 404 for an id the catalog does not hold.
POST
/
public-api
/
dashboards
/
templates
/
{template_id}
/
instantiate
Start a dashboard from a template
curl --request POST \
--url https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate', 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/dashboards/templates/{template_id}/instantiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.neoagent.io/public-api/dashboards/templates/{template_id}/instantiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"dataset": {
"columns": [
{
"key": "<string>",
"label": "<string>",
"type": "string",
"derived": false
}
],
"date_column": "<string>",
"id_column": "<string>",
"pinned_columns": [
"<string>"
]
},
"preview_widgets": [
{
"component": "stat_group",
"id": "<string>",
"layout": {
"h": 123,
"w": 123,
"x": 123,
"y": 123
},
"query": {
"columns": [
"<string>"
],
"filter": [
{
"column": "<string>",
"op": "eq",
"value": null
}
],
"group_by": [
{
"column": "<string>",
"bucket": "day"
}
],
"history": {
"last": 123,
"bucket": "day"
},
"limit": 1000,
"measure": [
{
"fn": "count",
"column": "<string>",
"label": "<string>",
"where": [
{
"column": "<string>",
"op": "eq",
"value": null
}
]
}
],
"sort": {
"by": "<string>",
"dir": "desc"
}
},
"title": "<string>"
}
],
"prompt": "<string>",
"spec": "<string>",
"template": {
"buildable": true,
"category": "<string>",
"client_scoped": true,
"description": "<string>",
"id": 123,
"missing_integrations": [
"<string>"
],
"name": "<string>",
"optional_integrations": [
"<string>"
],
"popular": true,
"required_integrations": [
"<string>"
],
"section": "<string>",
"supported_psas": [
"CONNECTWISE"
],
"tagline": "<string>"
}
},
"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).
