Resolve an unsaved segment definition against the roster.
curl --request POST \
--url https://{workspace}.klef.ai/api/segments/preview \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"clauses": [
{
"left": {
"value": "<string>"
},
"values": [
{
"value": "<string>"
}
]
}
],
"includedWorkerIds": [
"<string>"
],
"excludedWorkerIds": [
"<string>"
],
"q": "<string>",
"cursor": 123,
"limit": 123
}
'import requests
url = "https://{workspace}.klef.ai/api/segments/preview"
payload = {
"clauses": [
{
"left": { "value": "<string>" },
"values": [{ "value": "<string>" }]
}
],
"includedWorkerIds": ["<string>"],
"excludedWorkerIds": ["<string>"],
"q": "<string>",
"cursor": 123,
"limit": 123
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
clauses: [{left: {value: '<string>'}, values: [{value: '<string>'}]}],
includedWorkerIds: ['<string>'],
excludedWorkerIds: ['<string>'],
q: '<string>',
cursor: 123,
limit: 123
})
};
fetch('https://{workspace}.klef.ai/api/segments/preview', 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://{workspace}.klef.ai/api/segments/preview",
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([
'clauses' => [
[
'left' => [
'value' => '<string>'
],
'values' => [
[
'value' => '<string>'
]
]
]
],
'includedWorkerIds' => [
'<string>'
],
'excludedWorkerIds' => [
'<string>'
],
'q' => '<string>',
'cursor' => 123,
'limit' => 123
]),
CURLOPT_COOKIE => "klef.session=",
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://{workspace}.klef.ai/api/segments/preview"
payload := strings.NewReader("{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/segments/preview")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/segments/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"result": {
"workerCount": 123,
"includedCount": 123,
"workers": [
{
"id": "<string>",
"name": "<string>",
"email": "<string>",
"pinned": true
}
],
"pagination": {
"nextCursor": 123,
"limit": 123,
"hasMore": true,
"total": 123
}
},
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}Segments
Resolve an unsaved segment definition against the roster.
Lets an editor show who a change would catch before it is saved. The body carries the definition rather than a segment id, so nothing is persisted.
POST
/
segments
/
preview
Resolve an unsaved segment definition against the roster.
curl --request POST \
--url https://{workspace}.klef.ai/api/segments/preview \
--header 'Content-Type: application/json' \
--cookie klef.session= \
--data '
{
"clauses": [
{
"left": {
"value": "<string>"
},
"values": [
{
"value": "<string>"
}
]
}
],
"includedWorkerIds": [
"<string>"
],
"excludedWorkerIds": [
"<string>"
],
"q": "<string>",
"cursor": 123,
"limit": 123
}
'import requests
url = "https://{workspace}.klef.ai/api/segments/preview"
payload = {
"clauses": [
{
"left": { "value": "<string>" },
"values": [{ "value": "<string>" }]
}
],
"includedWorkerIds": ["<string>"],
"excludedWorkerIds": ["<string>"],
"q": "<string>",
"cursor": 123,
"limit": 123
}
headers = {
"cookie": "klef.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'klef.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
clauses: [{left: {value: '<string>'}, values: [{value: '<string>'}]}],
includedWorkerIds: ['<string>'],
excludedWorkerIds: ['<string>'],
q: '<string>',
cursor: 123,
limit: 123
})
};
fetch('https://{workspace}.klef.ai/api/segments/preview', 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://{workspace}.klef.ai/api/segments/preview",
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([
'clauses' => [
[
'left' => [
'value' => '<string>'
],
'values' => [
[
'value' => '<string>'
]
]
]
],
'includedWorkerIds' => [
'<string>'
],
'excludedWorkerIds' => [
'<string>'
],
'q' => '<string>',
'cursor' => 123,
'limit' => 123
]),
CURLOPT_COOKIE => "klef.session=",
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://{workspace}.klef.ai/api/segments/preview"
payload := strings.NewReader("{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "klef.session=")
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://{workspace}.klef.ai/api/segments/preview")
.header("cookie", "klef.session=")
.header("Content-Type", "application/json")
.body("{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/segments/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'klef.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"clauses\": [\n {\n \"left\": {\n \"value\": \"<string>\"\n },\n \"values\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"includedWorkerIds\": [\n \"<string>\"\n ],\n \"excludedWorkerIds\": [\n \"<string>\"\n ],\n \"q\": \"<string>\",\n \"cursor\": 123,\n \"limit\": 123\n}"
response = http.request(request)
puts response.read_body{
"result": {
"workerCount": 123,
"includedCount": 123,
"workers": [
{
"id": "<string>",
"name": "<string>",
"email": "<string>",
"pinned": true
}
],
"pagination": {
"nextCursor": 123,
"limit": 123,
"hasMore": true,
"total": 123
}
},
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}Authorizations
cookieAuthapiKeyAuth
Cookie-based session. Obtain by completing the /auth/login/{provider} OAuth flow; the /auth/callback response sets the klef.session cookie that subsequent requests send automatically.
Body
application/json
A segment definition the editor has not saved yet, asked about against the roster.
Where a segment's membership comes from.
Available options:
rule_based, manual How a condition node combines its clauses.
Available options:
all, any Show child attributes
Show child attributes
Maximum string length:
100Response
OK
Was this page helpful?