Skip to main content
POST
Redact a run

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

runId
string
required

Opaque identifier of the run.

Pattern: ^run_[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}$

Response

Response type for a pipeline run.

A run is addressed by its own opaque id; the owning pipeline and workspace slugs are carried for context.

Response type for a pipeline run.

A run is addressed by its own opaque id; the owning pipeline and workspace slugs are carried for context.

id
string
required

Opaque identifier of the run.

Pattern: ^run_[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}$
inputFileId
string<uuid>
required

Source document this run analyzes / redacts.

metadata
object
required

Non-encrypted metadata for filtering/display.

pipelineSlug
string
required

Handle of the pipeline this run belongs to.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
startedAt
string<date-time>
required

When the run started.

status
required

Current run status.

The detections are available to fetch from the run's detections endpoint once this reaches analyzed.

Allowed value: "queued"
triggerType
required

How the run was triggered.

Allowed value: "user"
triggeredBy
object
required

Account that triggered the run.

workspaceSlug
string
required

Handle of the workspace this run belongs to.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
completedAt
string<date-time>

When the run completed.

error
string

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

inputFileName
string

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

outputFileId
string<uuid>

Redacted document produced by the run, once it completes.

outputFileName
string

Display name of the redacted output, once the run completes.