Start an ad-hoc detection

POST

workspaces

{workspaceId}

detections

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceId}/detections \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "retentionOverride": {
    "auditLogs": {
      "mode": "persistent"
    },
    "intermediates": {
      "mode": "persistent"
    },
    "redactedDocuments": {
      "mode": "persistent"
    }
  },
  "scope": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": "<string>",
      "tags": []
    }
  }
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceId}/detections"

payload = {
    "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policyIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "retentionOverride": {
        "auditLogs": { "mode": "persistent" },
        "intermediates": { "mode": "persistent" },
        "redactedDocuments": { "mode": "persistent" }
    },
    "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',
    policyIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    retentionOverride: {
      auditLogs: {mode: 'persistent'},
      intermediates: {mode: 'persistent'},
      redactedDocuments: {mode: 'persistent'}
    },
    scope: {
      countries: ['<string>'],
      languages: [],
      metadata: {audience: [], purpose: '<string>', tags: []}
    }
  })
};

fetch('https://api.example.com/workspaces/{workspaceId}/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}/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',
    'policyIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'retentionOverride' => [
        'auditLogs' => [
                'mode' => 'persistent'
        ],
        'intermediates' => [
                'mode' => 'persistent'
        ],
        'redactedDocuments' => [
                'mode' => 'persistent'
        ]
    ],
    '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}/detections"

	payload := strings.NewReader("{\n  \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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}/detections")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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}/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  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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>"
}

"<string>"

"<string>"

Path Parameters

workspaceId

string<uuid>

required

Workspace identifier.

Body

application/json

Request payload to start an ad-hoc detection over a document, naming its policies directly rather than through a pipeline.

Analyzes the document against the given policies (authored or one-shot) and returns the detection holding the findings for review before redaction.

Request payload to start an ad-hoc detection over a document, naming its policies directly rather than through a pipeline.

Analyzes the document against the given policies (authored or one-shot) and returns the detection holding the findings for review before redaction.

documentId

string<uuid>

required

The document to analyze.

policyIds

string<uuid>[]

required

The policies to run against, by id. At least one is required.

Required array length: 1 - 64 elements

retentionOverride

object

Retention override for the outputs this detection produces. Absent falls back to the workspace retention baseline.

Show child attributes

scope

object

Per-document scope (languages, jurisdictions, document labels).

Show child attributes

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.

string

required

Opaque identifier of the detection.

Pattern: ^detection_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

inputDocumentId

string<uuid>

required

Source document this detection analyzes.

metadata

object

required

Non-encrypted metadata for filtering/display.

Show child attributes

startedAt

string<date-time>

required

When the detection started.

status

required

Current detection status.

The detections are available to fetch from the detection's analysis endpoint once this reaches complete.

Allowed value: "pending"

triggerType

required

How the detection was triggered.

Allowed value: "user"

triggeredBy

object

required

Account that triggered the detection.

Show child attributes

workspaceHandle

string

required

URL-safe workspace handle. Display-only.

Required string length: 3 - 32

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

workspaceId

string<uuid>

required

Unique identifier of the workspace.

completedAt

string<date-time>

When the detection completed analysis.

error

string

Human-readable failure reason, present only when the detection failed.

inputDocumentName

string

Display name of the source document, for showing the detection without a separate file lookup. None if the file was removed (e.g. by retention).

pipelineId

string<uuid>

Unique identifier of the pipeline this detection belongs to; absent for an ad-hoc detection.

Start an ad-hoc detection

curl --request POST \
  --url https://api.example.com/workspaces/{workspaceId}/detections \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "policyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "retentionOverride": {
    "auditLogs": {
      "mode": "persistent"
    },
    "intermediates": {
      "mode": "persistent"
    },
    "redactedDocuments": {
      "mode": "persistent"
    }
  },
  "scope": {
    "countries": [
      "<string>"
    ],
    "languages": [],
    "metadata": {
      "audience": [],
      "purpose": "<string>",
      "tags": []
    }
  }
}
'

import requests

url = "https://api.example.com/workspaces/{workspaceId}/detections"

payload = {
    "documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policyIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "retentionOverride": {
        "auditLogs": { "mode": "persistent" },
        "intermediates": { "mode": "persistent" },
        "redactedDocuments": { "mode": "persistent" }
    },
    "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',
    policyIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    retentionOverride: {
      auditLogs: {mode: 'persistent'},
      intermediates: {mode: 'persistent'},
      redactedDocuments: {mode: 'persistent'}
    },
    scope: {
      countries: ['<string>'],
      languages: [],
      metadata: {audience: [], purpose: '<string>', tags: []}
    }
  })
};

fetch('https://api.example.com/workspaces/{workspaceId}/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}/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',
    'policyIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'retentionOverride' => [
        'auditLogs' => [
                'mode' => 'persistent'
        ],
        'intermediates' => [
                'mode' => 'persistent'
        ],
        'redactedDocuments' => [
                'mode' => 'persistent'
        ]
    ],
    '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}/detections"

	payload := strings.NewReader("{\n  \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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}/detections")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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}/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  \"policyIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"retentionOverride\": {\n    \"auditLogs\": {\n      \"mode\": \"persistent\"\n    },\n    \"intermediates\": {\n      \"mode\": \"persistent\"\n    },\n    \"redactedDocuments\": {\n      \"mode\": \"persistent\"\n    }\n  },\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>"
}

"<string>"

"<string>"

API Reference

Endpoints

Start an ad-hoc detection

Path Parameters

Body

Response