Text to Segment Builder
curl --request POST \
--url https://api.embedreach.com/api/segments/text-to-segment \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"userCustomVerb": "user"
}
'import requests
url = "https://api.embedreach.com/api/segments/text-to-segment"
payload = {
"text": "<string>",
"userCustomVerb": "user"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({text: '<string>', userCustomVerb: 'user'})
};
fetch('https://api.embedreach.com/api/segments/text-to-segment', 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.embedreach.com/api/segments/text-to-segment",
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([
'text' => '<string>',
'userCustomVerb' => 'user'
]),
CURLOPT_HTTPHEADER => [
"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.embedreach.com/api/segments/text-to-segment"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.embedreach.com/api/segments/text-to-segment")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/segments/text-to-segment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"failureReason": "<string>",
"conditionGroups": [
{
"conditions": [
{
"value": [
"<string>"
],
"type": "property",
"description": "<string>"
}
],
"type": "group",
"description": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}Segments
Text to Segment Builder
Text to segment builder
POST
/
api
/
segments
/
text-to-segment
Text to Segment Builder
curl --request POST \
--url https://api.embedreach.com/api/segments/text-to-segment \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"userCustomVerb": "user"
}
'import requests
url = "https://api.embedreach.com/api/segments/text-to-segment"
payload = {
"text": "<string>",
"userCustomVerb": "user"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({text: '<string>', userCustomVerb: 'user'})
};
fetch('https://api.embedreach.com/api/segments/text-to-segment', 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.embedreach.com/api/segments/text-to-segment",
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([
'text' => '<string>',
'userCustomVerb' => 'user'
]),
CURLOPT_HTTPHEADER => [
"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.embedreach.com/api/segments/text-to-segment"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.embedreach.com/api/segments/text-to-segment")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/segments/text-to-segment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"userCustomVerb\": \"user\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"failureReason": "<string>",
"conditionGroups": [
{
"conditions": [
{
"value": [
"<string>"
],
"type": "property",
"description": "<string>"
}
],
"type": "group",
"description": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}Headers
If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
Body
application/json
The text to build a segment from
The custom verb used to describe users (e.g. if you use "patrons" instead of "users"). Defaults to "user"
Response
Status 200 response
Whether the text to segment was successful
The reason the text to segment was not successful.
The condition groups to include in the segment. Groups are AND-joined with each other; conditions within a group use that group logic.
Show child attributes
Show child attributes
A suggested title for the segment generated by AI
A suggested description for the segment generated by AI
⌘I