Start a detection
Starts analysis for a document and returns 202 with the detection in the pending state; the analysis runs in the background. Watch the detection’s status via the SSE stream at .../detections/{detectionId}/events (or re-read the detection) and fetch the findings from .../detections/{detectionId}/analysis/ once it reaches complete. A repeated Idempotency-Key returns the existing detection.
curl --request POST \
--url https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections \
--header 'Content-Type: application/json' \
--data '
{
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"countries": [
"<string>"
],
"languages": [],
"metadata": {
"audience": [],
"purpose": "<string>",
"tags": []
}
}
}
'import requests
url = "https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"
payload = {
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"countries": ["<string>"],
"languages": [],
"metadata": {
"audience": [],
"purpose": "<string>",
"tags": []
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
documentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: {
countries: ['<string>'],
languages: [],
metadata: {audience: [], purpose: '<string>', tags: []}
}
})
};
fetch('https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections', 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.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections",
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([
'documentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => [
'countries' => [
'<string>'
],
'languages' => [
],
'metadata' => [
'audience' => [
],
'purpose' => '<string>',
'tags' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"
payload := strings.NewReader("{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")
.header("Content-Type", "application/json")
.body("{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"error": "<string>",
"tags": [
"<string>"
],
"usage": "<unknown>"
},
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "user",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z",
"error": "<string>",
"inputDocumentName": "<string>",
"pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"id": "<string>",
"inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"error": "<string>",
"tags": [
"<string>"
],
"usage": "<unknown>"
},
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "user",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z",
"error": "<string>",
"inputDocumentName": "<string>",
"pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}<string><string>Path Parameters
Body
Request payload to start a detection over a document.
Analyzes the document with the pipeline's configuration and returns the detection, which holds the findings for review before redaction.
Request payload to start a detection over a document.
Analyzes the document with the pipeline's configuration and returns the detection, which holds the findings for review before redaction.
Response
Response type for a detection.
A detection is addressed by its own opaque id; the owning pipeline and
workspace handles are carried for context. Redacted outputs are not here — a
detection produces many redactions, each fetched from its redactions
endpoint.
Response type for a detection.
A detection is addressed by its own opaque id; the owning pipeline and
workspace handles are carried for context. Redacted outputs are not here — a
detection produces many redactions, each fetched from its redactions
endpoint.
curl --request POST \
--url https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections \
--header 'Content-Type: application/json' \
--data '
{
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"countries": [
"<string>"
],
"languages": [],
"metadata": {
"audience": [],
"purpose": "<string>",
"tags": []
}
}
}
'import requests
url = "https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"
payload = {
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": {
"countries": ["<string>"],
"languages": [],
"metadata": {
"audience": [],
"purpose": "<string>",
"tags": []
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
documentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scope: {
countries: ['<string>'],
languages: [],
metadata: {audience: [], purpose: '<string>', tags: []}
}
})
};
fetch('https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections', 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.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections",
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([
'documentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scope' => [
'countries' => [
'<string>'
],
'languages' => [
],
'metadata' => [
'audience' => [
],
'purpose' => '<string>',
'tags' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections"
payload := strings.NewReader("{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")
.header("Content-Type", "application/json")
.body("{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}/pipelines/{pipelineId}/detections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scope\": {\n \"countries\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"metadata\": {\n \"audience\": [],\n \"purpose\": \"<string>\",\n \"tags\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"error": "<string>",
"tags": [
"<string>"
],
"usage": "<unknown>"
},
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "user",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z",
"error": "<string>",
"inputDocumentName": "<string>",
"pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"id": "<string>",
"inputDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"error": "<string>",
"tags": [
"<string>"
],
"usage": "<unknown>"
},
"startedAt": "2023-11-07T05:31:56Z",
"status": "pending",
"triggerType": "user",
"triggeredBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"workspaceHandle": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"completedAt": "2023-11-07T05:31:56Z",
"error": "<string>",
"inputDocumentName": "<string>",
"pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}<string><string>