Create a label version
curl --request POST \
--url https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"description": "<string>",
"parentLabelVersionId": "<string>",
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"confirmDuplicate": true,
"textFormat": "TEXT_FORMAT_UNSPECIFIED"
}
'import requests
url = "https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions"
payload = {
"text": "<string>",
"description": "<string>",
"parentLabelVersionId": "<string>",
"labelEvalOptions": {
"bypassCache": True,
"expedited": True,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"confirmDuplicate": True,
"textFormat": "TEXT_FORMAT_UNSPECIFIED"
}
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({
text: '<string>',
description: '<string>',
parentLabelVersionId: '<string>',
labelEvalOptions: {
bypassCache: true,
expedited: true,
bundleSize: 123,
threshold: 123,
stack: '<string>',
imageDetailLevel: 'IMAGE_DETAIL_LEVEL_UNSPECIFIED'
},
globalContext: '<string>',
confirmDuplicate: true,
textFormat: 'TEXT_FORMAT_UNSPECIFIED'
})
};
fetch('https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8443",
CURLOPT_URL => "https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions",
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>',
'description' => '<string>',
'parentLabelVersionId' => '<string>',
'labelEvalOptions' => [
'bypassCache' => true,
'expedited' => true,
'bundleSize' => 123,
'threshold' => 123,
'stack' => '<string>',
'imageDetailLevel' => 'IMAGE_DETAIL_LEVEL_UNSPECIFIED'
],
'globalContext' => '<string>',
'confirmDuplicate' => true,
'textFormat' => 'TEXT_FORMAT_UNSPECIFIED'
]),
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://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\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://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions")
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 \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"error": {
"message": "<string>",
"line": 123,
"column": 123
},
"labelVersion": {
"labelVersionId": "<string>",
"labelId": "<string>",
"text": "<string>",
"blob": "aSDinaTvuI8gbWludGxpZnk=",
"description": "<string>",
"signalCount": 123,
"totalSignalTokens": 123,
"created": "2023-11-07T05:31:56Z",
"expunged": true,
"createdById": "<string>",
"sequentialVersion": 123,
"parentLabelVersionId": "<string>",
"complexityScore": 123,
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"tokenCountsV2": {
"dslTokenCount": 123,
"globalContextTokens": 123,
"signalTokens": 123,
"signalSpecialTokens": 123,
"contentSpecialTokens": 123
}
},
"duplicateOf": {
"labelVersionId": "<string>",
"labelId": "<string>",
"text": "<string>",
"blob": "aSDinaTvuI8gbWludGxpZnk=",
"description": "<string>",
"signalCount": 123,
"totalSignalTokens": 123,
"created": "2023-11-07T05:31:56Z",
"expunged": true,
"createdById": "<string>",
"sequentialVersion": 123,
"parentLabelVersionId": "<string>",
"complexityScore": 123,
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"tokenCountsV2": {
"dslTokenCount": 123,
"globalContextTokens": 123,
"signalTokens": 123,
"signalSpecialTokens": 123,
"contentSpecialTokens": 123
}
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Label Versions
Create a label version
Publishes an immutable version under the label. text is single-label DSL by default; set text_format to TEXT_FORMAT_PLAIN_TEXT to send a plain-language rule instead, which is stored as a single signal. Reads always return the compiled DSL, not the text that was submitted. There is no current/live version: evaluation always uses an explicit version ID. There is no PATCH or DELETE for versions. Requires a label-first account; other accounts receive FAILED_PRECONDITION.
POST
/
v1
/
labels
/
{labelId}
/
versions
Create a label version
curl --request POST \
--url https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"description": "<string>",
"parentLabelVersionId": "<string>",
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"confirmDuplicate": true,
"textFormat": "TEXT_FORMAT_UNSPECIFIED"
}
'import requests
url = "https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions"
payload = {
"text": "<string>",
"description": "<string>",
"parentLabelVersionId": "<string>",
"labelEvalOptions": {
"bypassCache": True,
"expedited": True,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"confirmDuplicate": True,
"textFormat": "TEXT_FORMAT_UNSPECIFIED"
}
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({
text: '<string>',
description: '<string>',
parentLabelVersionId: '<string>',
labelEvalOptions: {
bypassCache: true,
expedited: true,
bundleSize: 123,
threshold: 123,
stack: '<string>',
imageDetailLevel: 'IMAGE_DETAIL_LEVEL_UNSPECIFIED'
},
globalContext: '<string>',
confirmDuplicate: true,
textFormat: 'TEXT_FORMAT_UNSPECIFIED'
})
};
fetch('https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8443",
CURLOPT_URL => "https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions",
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>',
'description' => '<string>',
'parentLabelVersionId' => '<string>',
'labelEvalOptions' => [
'bypassCache' => true,
'expedited' => true,
'bundleSize' => 123,
'threshold' => 123,
'stack' => '<string>',
'imageDetailLevel' => 'IMAGE_DETAIL_LEVEL_UNSPECIFIED'
],
'globalContext' => '<string>',
'confirmDuplicate' => true,
'textFormat' => 'TEXT_FORMAT_UNSPECIFIED'
]),
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://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\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://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.app.clavata.ai:8443/v1/labels/{labelId}/versions")
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 \"text\": \"<string>\",\n \"description\": \"<string>\",\n \"parentLabelVersionId\": \"<string>\",\n \"labelEvalOptions\": {\n \"bypassCache\": true,\n \"expedited\": true,\n \"bundleSize\": 123,\n \"threshold\": 123,\n \"stack\": \"<string>\",\n \"imageDetailLevel\": \"IMAGE_DETAIL_LEVEL_UNSPECIFIED\"\n },\n \"globalContext\": \"<string>\",\n \"confirmDuplicate\": true,\n \"textFormat\": \"TEXT_FORMAT_UNSPECIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"error": {
"message": "<string>",
"line": 123,
"column": 123
},
"labelVersion": {
"labelVersionId": "<string>",
"labelId": "<string>",
"text": "<string>",
"blob": "aSDinaTvuI8gbWludGxpZnk=",
"description": "<string>",
"signalCount": 123,
"totalSignalTokens": 123,
"created": "2023-11-07T05:31:56Z",
"expunged": true,
"createdById": "<string>",
"sequentialVersion": 123,
"parentLabelVersionId": "<string>",
"complexityScore": 123,
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"tokenCountsV2": {
"dslTokenCount": 123,
"globalContextTokens": 123,
"signalTokens": 123,
"signalSpecialTokens": 123,
"contentSpecialTokens": 123
}
},
"duplicateOf": {
"labelVersionId": "<string>",
"labelId": "<string>",
"text": "<string>",
"blob": "aSDinaTvuI8gbWludGxpZnk=",
"description": "<string>",
"signalCount": 123,
"totalSignalTokens": 123,
"created": "2023-11-07T05:31:56Z",
"expunged": true,
"createdById": "<string>",
"sequentialVersion": 123,
"parentLabelVersionId": "<string>",
"complexityScore": 123,
"labelEvalOptions": {
"bypassCache": true,
"expedited": true,
"bundleSize": 123,
"threshold": 123,
"stack": "<string>",
"imageDetailLevel": "IMAGE_DETAIL_LEVEL_UNSPECIFIED"
},
"globalContext": "<string>",
"tokenCountsV2": {
"dslTokenCount": 123,
"globalContextTokens": 123,
"signalTokens": 123,
"signalSpecialTokens": 123,
"contentSpecialTokens": 123
}
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The label ID this version belongs to
Body
application/json
Optional description for this version.
Optional explicit parent/source version for lineage tracking.
LabelEvalOptions are options that can be set per-label to control evaluation behavior. Field numbers/types intentionally mirror PolicyEvalOptions for parity.
Show child attributes
Show child attributes
Optional global context to store on the created label version.
If true, bypass the duplicate-content check. Used by clients to
re-submit after the user has acknowledged a duplicate_of response.
How the text on a version-create request should be interpreted.
- TEXT_FORMAT_UNSPECIFIED: Unspecified defaults to DSL for backward compatibility.
- TEXT_FORMAT_DSL: Single-label V3 DSL.
- TEXT_FORMAT_PLAIN_TEXT: Plain rule text, stored as a single signal. Callers using this do not need to know the DSL; the text is wrapped before compilation.
Available options:
TEXT_FORMAT_UNSPECIFIED, TEXT_FORMAT_DSL, TEXT_FORMAT_PLAIN_TEXT Response
A successful response.
Was this page helpful?