Redactions
Get redaction job status
Return a lightweight status snapshot for polling. Includes just the fields needed to advance a job from pending or processing to a terminal state.
GET
/
v1
/
redactions
/
{redactionId}
/
status
Get redaction job status
curl --request GET \
--url https://api.slate.inc/files/v1/redactions/{redactionId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.slate.inc/files/v1/redactions/{redactionId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.slate.inc/files/v1/redactions/{redactionId}/status', 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://api.slate.inc/files/v1/redactions/{redactionId}/status",
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://api.slate.inc/files/v1/redactions/{redactionId}/status"
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://api.slate.inc/files/v1/redactions/{redactionId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/redactions/{redactionId}/status")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"completedOn": "2023-11-07T05:31:56Z",
"redactionDuration": "<string>",
"errorMessage": "<string>",
"summary": {
"ocrUsed": true,
"rules": [
{
"textCount": 123,
"ocrCount": 123,
"redactions": [
{
"page": 123,
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"confidence": 123,
"source": "ocr"
}
]
}
]
}
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}Authorizations
Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.
Path Parameters
Response
Redaction job status snapshot
Lightweight status snapshot returned by GET /v1/redactions/{redactionId}/status for polling.
Current status of an asynchronous redaction job
Available options:
pending, processing, completed, failed Populated when processing fails; null otherwise.
Per-rule redaction counts and OCR signals. Null until the job completes.
Show child attributes
Show child attributes
⌘I
Get redaction job status
curl --request GET \
--url https://api.slate.inc/files/v1/redactions/{redactionId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.slate.inc/files/v1/redactions/{redactionId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.slate.inc/files/v1/redactions/{redactionId}/status', 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://api.slate.inc/files/v1/redactions/{redactionId}/status",
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://api.slate.inc/files/v1/redactions/{redactionId}/status"
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://api.slate.inc/files/v1/redactions/{redactionId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.slate.inc/files/v1/redactions/{redactionId}/status")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"completedOn": "2023-11-07T05:31:56Z",
"redactionDuration": "<string>",
"errorMessage": "<string>",
"summary": {
"ocrUsed": true,
"rules": [
{
"textCount": 123,
"ocrCount": 123,
"redactions": [
{
"page": 123,
"x": 123,
"y": 123,
"w": 123,
"h": 123,
"confidence": 123,
"source": "ocr"
}
]
}
]
}
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}{
"message": "<string>",
"reason": "MISSING_TOKEN_OR_PERMISSIONS"
}