Draft a full campaign blueprint from a plain-English goal
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/ai/compose-campaign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"goal": "<string>",
"audience_description": "<string>",
"channels": [
"sms"
],
"tone": "friendly",
"brand_name": "<string>",
"locale": "en"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/ai/compose-campaign"
payload = {
"goal": "<string>",
"audience_description": "<string>",
"channels": ["sms"],
"tone": "friendly",
"brand_name": "<string>",
"locale": "en"
}
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({
goal: '<string>',
audience_description: '<string>',
channels: ['sms'],
tone: 'friendly',
brand_name: '<string>',
locale: 'en'
})
};
fetch('https://api.orbit.devotel.io/api/v1/ai/compose-campaign', 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.orbit.devotel.io/api/v1/ai/compose-campaign",
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([
'goal' => '<string>',
'audience_description' => '<string>',
'channels' => [
'sms'
],
'tone' => 'friendly',
'brand_name' => '<string>',
'locale' => 'en'
]),
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.orbit.devotel.io/api/v1/ai/compose-campaign"
payload := strings.NewReader("{\n \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\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://api.orbit.devotel.io/api/v1/ai/compose-campaign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/ai/compose-campaign")
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 \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}AI
Draft a full campaign blueprint from a plain-English goal
POST
/
api
/
v1
/
ai
/
compose-campaign
Draft a full campaign blueprint from a plain-English goal
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/ai/compose-campaign \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"goal": "<string>",
"audience_description": "<string>",
"channels": [
"sms"
],
"tone": "friendly",
"brand_name": "<string>",
"locale": "en"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/ai/compose-campaign"
payload = {
"goal": "<string>",
"audience_description": "<string>",
"channels": ["sms"],
"tone": "friendly",
"brand_name": "<string>",
"locale": "en"
}
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({
goal: '<string>',
audience_description: '<string>',
channels: ['sms'],
tone: 'friendly',
brand_name: '<string>',
locale: 'en'
})
};
fetch('https://api.orbit.devotel.io/api/v1/ai/compose-campaign', 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.orbit.devotel.io/api/v1/ai/compose-campaign",
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([
'goal' => '<string>',
'audience_description' => '<string>',
'channels' => [
'sms'
],
'tone' => 'friendly',
'brand_name' => '<string>',
'locale' => 'en'
]),
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.orbit.devotel.io/api/v1/ai/compose-campaign"
payload := strings.NewReader("{\n \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\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://api.orbit.devotel.io/api/v1/ai/compose-campaign")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/ai/compose-campaign")
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 \"goal\": \"<string>\",\n \"audience_description\": \"<string>\",\n \"channels\": [\n \"sms\"\n ],\n \"tone\": \"friendly\",\n \"brand_name\": \"<string>\",\n \"locale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"data": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Plain-English campaign goal (5-2,000 chars).
Required string length:
5 - 2000Available options:
champion, high_value_engaged, engaged, new, passive, at_risk, dormant, lost Maximum string length:
1000Required array length:
1 - 4 elementsAvailable options:
sms, whatsapp, email, voice Available options:
professional, casual, urgent, friendly, empathetic Maximum string length:
80Maximum string length:
10⌘I