curl --request GET \
--url https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels \
--header 'Authorization: Bearer <token>'import requests
url = "https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels', 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/jobs/{jobUuid}/labels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"labels": [
{
"label": "<string>",
"startMs": "<string>",
"startTimecode": "<string>",
"modality": "MODALITY_UNSPECIFIED",
"score": 123,
"endMs": "<string>",
"endTimecode": "<string>",
"frameStartMs": "<string>",
"frameEndMs": "<string>",
"frameStartTimecode": "<string>",
"frameEndTimecode": "<string>",
"transcriptStartMs": "<string>",
"transcriptEndMs": "<string>",
"transcriptStartTimecode": "<string>",
"transcriptEndTimecode": "<string>"
}
],
"status": "JOB_STATUS_UNSPECIFIED",
"error": {
"reason": "JOB_ERROR_REASON_UNSPECIFIED",
"message": "<string>"
},
"nextPageToken": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"type": "PRECHECK_FAILURE_TYPE_UNSPECIFIED",
"message": "<string>",
"details": "<unknown>",
"matchConfidence": "PRECHECK_MATCH_CONFIDENCE_UNSPECIFIED"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Get job label hits
Retrieves label occurrences for a job, projected to label, modality, score, and timed fields (start_ms/end_ms and their timecodes). Video frame hits are point-in-time (start only); audio chunk hits are ranged when end_ms is set. Set the optional job_result_id to scope the response to a single result of the job. Hits are paged in a stable order: results in the order they were recorded, and each resultโs hits in the order the evaluation recorded them (start time ascending for video). Omitting page_size uses the default of 1000. The maximum page_size is 1000. Negative page_size is rejected. When more hits remain, next_page_token is set; pass it as page_token with the same job_uuid and job_result_id to fetch the next page. An incomplete job returns its status with no labels and no next_page_token. Available to policy-first and label-first accounts; works on any job in the account, including jobs from POST /v1/labels/evaluate.
curl --request GET \
--url https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels \
--header 'Authorization: Bearer <token>'import requests
url = "https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels', 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/jobs/{jobUuid}/labels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.app.clavata.ai:8443/v1/jobs/{jobUuid}/labels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"labels": [
{
"label": "<string>",
"startMs": "<string>",
"startTimecode": "<string>",
"modality": "MODALITY_UNSPECIFIED",
"score": 123,
"endMs": "<string>",
"endTimecode": "<string>",
"frameStartMs": "<string>",
"frameEndMs": "<string>",
"frameStartTimecode": "<string>",
"frameEndTimecode": "<string>",
"transcriptStartMs": "<string>",
"transcriptEndMs": "<string>",
"transcriptStartTimecode": "<string>",
"transcriptEndTimecode": "<string>"
}
],
"status": "JOB_STATUS_UNSPECIFIED",
"error": {
"reason": "JOB_ERROR_REASON_UNSPECIFIED",
"message": "<string>"
},
"nextPageToken": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"type": "PRECHECK_FAILURE_TYPE_UNSPECIFIED",
"message": "<string>",
"details": "<unknown>",
"matchConfidence": "PRECHECK_MATCH_CONFIDENCE_UNSPECIFIED"
}
]
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
job_uuid is the unique identifier of the job
Query Parameters
job_result_id scopes the response to a single result of the job (e.g. the ContentFeedEntry.job_result_id backing one content-feed row). When unset, labels from every result in the job are returned.
Pagination: maximum number of label hits to return. When unset or 0, defaults to 1000. Maximum 1000; larger values are treated as 1000. Negative values are rejected.
Pagination: the next_page_token from a previous response for the same job_uuid and job_result_id. Omit to fetch the first page.
Response
A successful response.
Show child attributes
Show child attributes
JOB_STATUS_UNSPECIFIED, JOB_STATUS_PENDING, JOB_STATUS_RUNNING, JOB_STATUS_COMPLETED, JOB_STATUS_FAILED, JOB_STATUS_CANCELED Details about a terminal job failure. Job status remains the authoritative success/failure signal; this message provides a stable machine-readable reason and a human-readable explanation when status is JOB_STATUS_FAILED.
message is the fixed explanation for the reason, not worker error text, so it is safe to display but not useful to parse โ branch on reason instead.
Show child attributes
Show child attributes
Set when more label hits remain after this page. Pass it as page_token to fetch the next page.
Was this page helpful?