Get a text moderation batch
curl --request GET \
--url http://localhost:3051/api/v1/moderate/text/batch/{batch_id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3051/api/v1/moderate/text/batch/{batch_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_PORT => "3051",
CURLOPT_URL => "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}",
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 := "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}"
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("http://localhost:3051/api/v1/moderate/text/batch/{batch_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3051/api/v1/moderate/text/batch/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"type": "text_batch",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"items": [
{
"key": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"is_prohibited": true,
"reason": "<string>",
"error_code": "<string>"
}
]
}Moderation
Get a text moderation batch
Read every item decision of a batch. Each item shows its current decision. The batch status is completed once every item is completed or failed; the body is then the same as the batch webhook body, without delivery_id.
GET
/
api
/
v1
/
moderate
/
text
/
batch
/
{batch_id}
Get a text moderation batch
curl --request GET \
--url http://localhost:3051/api/v1/moderate/text/batch/{batch_id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3051/api/v1/moderate/text/batch/{batch_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_PORT => "3051",
CURLOPT_URL => "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}",
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 := "http://localhost:3051/api/v1/moderate/text/batch/{batch_id}"
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("http://localhost:3051/api/v1/moderate/text/batch/{batch_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3051/api/v1/moderate/text/batch/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"type": "text_batch",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "processing",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"items": [
{
"key": "<string>",
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"is_prohibited": true,
"reason": "<string>",
"error_code": "<string>"
}
]
}Requires the
job:read scope. Requests without this scope receive a 403 FORBIDDEN response. See
authentication.status stays processing until every item is completed or failed. Each item shows
its own decision as soon as it has one. Match items by key, not by position: the response orders
them by key.
A batch ID that does not exist, or that belongs to a different account, returns 404 BATCH_NOT_FOUND.Authorizations
API key from the Omnifence dashboard
Path Parameters
Response
200 - application/json
Default Response
Available options:
text_batch completed once every item is completed or failed, in the same step that sends the batch webhook.
Available options:
processing, completed One decision for each item, ordered by key. Match items by key.
Show child attributes
Show child attributes