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.
Path Parameters
Workspace identifier.
Id of the pipeline.
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.
Opaque identifier of the detection.
^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}$Source document this detection analyzes.
Non-encrypted metadata for filtering/display.
When the detection started.
Current detection status.
The detections are available to fetch from the detection's analysis
endpoint once this reaches complete.
"pending"How the detection was triggered.
"user"Account that triggered the detection.
URL-safe workspace handle. Display-only.
3 - 32^[a-z0-9]+(?:-[a-z0-9]+)*$Unique identifier of the workspace.
When the detection completed analysis.
Human-readable failure reason, present only when the detection failed.
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).
Unique identifier of the pipeline this detection belongs to; absent for an ad-hoc detection.