Flows
Compile and validate flow spec without publishing
Compiles a flow-spec DSL object (see GET /v1/schemas/flow-spec) and validates the result exactly like flows.publish would, without persisting anything. On success, returns the compiled node/edge graph. On failure, returns a 422 with structured errors (path/code/message/hint/candidates) — fix and retry before calling flows.publish.
POST
/
v1
/
flows
/
validate
Compile and validate flow spec without publishing
curl --request POST \
--url https://app.chatbotx.io/api/v1/flows/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"formatVersion": 1,
"name": "<string>",
"steps": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
{
"text": "<string>",
"then": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
"<unknown>"
]
}
]
}
]
}
]
}
}
'import requests
url = "https://app.chatbotx.io/api/v1/flows/validate"
payload = { "spec": {
"formatVersion": 1,
"name": "<string>",
"steps": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
{
"text": "<string>",
"then": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": ["<unknown>"]
}
]
}
]
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
formatVersion: 1,
name: '<string>',
steps: [
{
type: 'send',
id: '<string>',
text: '<string>',
imageUrl: '<string>',
fileUrl: '<string>',
buttons: [
{
text: '<string>',
then: [
{
type: 'send',
id: '<string>',
text: '<string>',
imageUrl: '<string>',
fileUrl: '<string>',
buttons: ['<unknown>']
}
]
}
]
}
]
}
})
};
fetch('https://app.chatbotx.io/api/v1/flows/validate', 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://app.chatbotx.io/api/v1/flows/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'formatVersion' => 1,
'name' => '<string>',
'steps' => [
[
'type' => 'send',
'id' => '<string>',
'text' => '<string>',
'imageUrl' => '<string>',
'fileUrl' => '<string>',
'buttons' => [
[
'text' => '<string>',
'then' => [
[
'type' => 'send',
'id' => '<string>',
'text' => '<string>',
'imageUrl' => '<string>',
'fileUrl' => '<string>',
'buttons' => [
'<unknown>'
]
]
]
]
]
]
]
]
]),
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://app.chatbotx.io/api/v1/flows/validate"
payload := strings.NewReader("{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.chatbotx.io/api/v1/flows/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/flows/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"nodes": [
{
"id": "<string>",
"position": {
"x": 123,
"y": 123
},
"measured": {
"width": 123,
"height": 123
},
"type": "sendMessage",
"data": {
"name": "<string>",
"isStartNode": true,
"details": {
"beforeStep": {
"id": "<string>",
"stepType": "chooseChannel",
"channel": "<string>"
},
"steps": [
{
"id": "<string>",
"stepType": "sendAudio",
"mode": "url",
"url": "<string>",
"buttons": [
null
],
"nodeId": "<string>"
}
],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"buttonType": "sendMessage",
"beforeStep": {
"id": "<unknown>",
"stepType": "<unknown>",
"nodeId": "<unknown>",
"viewOnly": "<unknown>"
},
"steps": [
null
]
}
]
}
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"sourceHandle": "<string>",
"target": "<string>",
"targetHandle": "<string>"
}
]
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "notFound",
"status": 404,
"message": "Resource not found",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A complete agent-authored flow DSL document.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Compile and validate flow spec without publishing
curl --request POST \
--url https://app.chatbotx.io/api/v1/flows/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"formatVersion": 1,
"name": "<string>",
"steps": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
{
"text": "<string>",
"then": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
"<unknown>"
]
}
]
}
]
}
]
}
}
'import requests
url = "https://app.chatbotx.io/api/v1/flows/validate"
payload = { "spec": {
"formatVersion": 1,
"name": "<string>",
"steps": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": [
{
"text": "<string>",
"then": [
{
"type": "send",
"id": "<string>",
"text": "<string>",
"imageUrl": "<string>",
"fileUrl": "<string>",
"buttons": ["<unknown>"]
}
]
}
]
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
formatVersion: 1,
name: '<string>',
steps: [
{
type: 'send',
id: '<string>',
text: '<string>',
imageUrl: '<string>',
fileUrl: '<string>',
buttons: [
{
text: '<string>',
then: [
{
type: 'send',
id: '<string>',
text: '<string>',
imageUrl: '<string>',
fileUrl: '<string>',
buttons: ['<unknown>']
}
]
}
]
}
]
}
})
};
fetch('https://app.chatbotx.io/api/v1/flows/validate', 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://app.chatbotx.io/api/v1/flows/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'spec' => [
'formatVersion' => 1,
'name' => '<string>',
'steps' => [
[
'type' => 'send',
'id' => '<string>',
'text' => '<string>',
'imageUrl' => '<string>',
'fileUrl' => '<string>',
'buttons' => [
[
'text' => '<string>',
'then' => [
[
'type' => 'send',
'id' => '<string>',
'text' => '<string>',
'imageUrl' => '<string>',
'fileUrl' => '<string>',
'buttons' => [
'<unknown>'
]
]
]
]
]
]
]
]
]),
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://app.chatbotx.io/api/v1/flows/validate"
payload := strings.NewReader("{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.chatbotx.io/api/v1/flows/validate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/flows/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"spec\": {\n \"formatVersion\": 1,\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"then\": [\n {\n \"type\": \"send\",\n \"id\": \"<string>\",\n \"text\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"buttons\": [\n \"<unknown>\"\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"nodes": [
{
"id": "<string>",
"position": {
"x": 123,
"y": 123
},
"measured": {
"width": 123,
"height": 123
},
"type": "sendMessage",
"data": {
"name": "<string>",
"isStartNode": true,
"details": {
"beforeStep": {
"id": "<string>",
"stepType": "chooseChannel",
"channel": "<string>"
},
"steps": [
{
"id": "<string>",
"stepType": "sendAudio",
"mode": "url",
"url": "<string>",
"buttons": [
null
],
"nodeId": "<string>"
}
],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"buttonType": "sendMessage",
"beforeStep": {
"id": "<unknown>",
"stepType": "<unknown>",
"nodeId": "<unknown>",
"viewOnly": "<unknown>"
},
"steps": [
null
]
}
]
}
}
}
],
"edges": [
{
"id": "<string>",
"source": "<string>",
"sourceHandle": "<string>",
"target": "<string>",
"targetHandle": "<string>"
}
]
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "notFound",
"status": 404,
"message": "Resource not found",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}