Replace segment
curl --request PUT \
--url https://{workspace}.klef.ai/api/segments/{id} \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--cookie klef.session= \
--data '
{
"name": "<string>",
"clauses": [
{
"left": {
"value": "<string>"
},
"values": [
{
"value": "<string>"
}
]
}
],
"includedWorkerIds": [
"<string>"
],
"excludedWorkerIds": [
"<string>"
]
}
'import requests
url = "https://{workspace}.klef.ai/api/segments/{id}"
payload = {
"name": "<string>",
"clauses": [
{
"left": { "value": "<string>" },
"values": [{ "value": "<string>" }]
}
],
"includedWorkerIds": ["<string>"],
"excludedWorkerIds": ["<string>"]
}
headers = {
"cookie": "klef.session=",
"If-Match": "<if-match>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
cookie: 'klef.session=',
'If-Match': '<if-match>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
clauses: [{left: {value: '<string>'}, values: [{value: '<string>'}]}],
includedWorkerIds: ['<string>'],
excludedWorkerIds: ['<string>']
})
};
fetch('https://{workspace}.klef.ai/api/segments/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'clauses' => [
[
'left' => [
'value' => '<string>'
],
'values' => [
[
'value' => '<string>'
]
]
]
],
'includedWorkerIds' => [
'<string>'
],
'excludedWorkerIds' => [
'<string>'
]
]),
CURLOPT_COOKIE => "klef.session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\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}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "klef.session=")
req.Header.Add("If-Match", "<if-match>")
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.put("https://{workspace}.klef.ai/api/segments/{id}")
.header("cookie", "klef.session=")
.header("If-Match", "<if-match>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/segments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'klef.session='
request["If-Match"] = '<if-match>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\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}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}{
"result": "<unknown>",
"errors": [
{
"errorCode": "validation_error",
"errorMessage": "<string>",
"target": "<string>"
}
]
}Segments
Replace segment
PUT
/
segments
/
{id}
Replace segment
curl --request PUT \
--url https://{workspace}.klef.ai/api/segments/{id} \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--cookie klef.session= \
--data '
{
"name": "<string>",
"clauses": [
{
"left": {
"value": "<string>"
},
"values": [
{
"value": "<string>"
}
]
}
],
"includedWorkerIds": [
"<string>"
],
"excludedWorkerIds": [
"<string>"
]
}
'import requests
url = "https://{workspace}.klef.ai/api/segments/{id}"
payload = {
"name": "<string>",
"clauses": [
{
"left": { "value": "<string>" },
"values": [{ "value": "<string>" }]
}
],
"includedWorkerIds": ["<string>"],
"excludedWorkerIds": ["<string>"]
}
headers = {
"cookie": "klef.session=",
"If-Match": "<if-match>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
cookie: 'klef.session=',
'If-Match': '<if-match>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
clauses: [{left: {value: '<string>'}, values: [{value: '<string>'}]}],
includedWorkerIds: ['<string>'],
excludedWorkerIds: ['<string>']
})
};
fetch('https://{workspace}.klef.ai/api/segments/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'clauses' => [
[
'left' => [
'value' => '<string>'
],
'values' => [
[
'value' => '<string>'
]
]
]
],
'includedWorkerIds' => [
'<string>'
],
'excludedWorkerIds' => [
'<string>'
]
]),
CURLOPT_COOKIE => "klef.session=",
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$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/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\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}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("cookie", "klef.session=")
req.Header.Add("If-Match", "<if-match>")
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.put("https://{workspace}.klef.ai/api/segments/{id}")
.header("cookie", "klef.session=")
.header("If-Match", "<if-match>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.klef.ai/api/segments/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["cookie"] = 'klef.session='
request["If-Match"] = '<if-match>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\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}"
response = http.request(request)
puts response.read_body{
"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>"
}
]
}{
"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.
Headers
Strong ETag (e.g. "3") of the resource's current version, from the most recent GET or write. Required for the write to proceed; a missing header returns 428, a malformed value returns 400.
Path Parameters
Body
application/json
Required string length:
4 - 200Where 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
Response
No Content
Was this page helpful?