Skip to main content
POST
/
files
/
{id}
/
redact
Start a redaction job
curl --request POST \
  --url https://api.indoralabs.com/files/{id}/redact \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "policyIds": [
    "<string>"
  ],
  "targets": [
    "<string>"
  ],
  "sampleFps": 15,
  "executionMode": "auto"
}
'
{
  "ok": true,
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "outputS3Uri": "<string>",
  "detectedType": "video"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

UUID of the file to redact.

Body

application/json
​
policyIds
string[]

List of policy document IDs used to resolve redaction rules.

Minimum string length: 1
​
targets
string[]

Manual redaction targets such as labels or semantic instructions.

Minimum string length: 1
​
sampleFps
integer

Frame sampling rate for video redaction. Lower values increase speed. Higher values increase accuracy.

Required range: 1 <= x <= 30
​
executionMode
enum<string>
default:auto

Redaction execution behavior. 'auto' performs detection and burning. 'detect' runs detection only. 'burn' applies existing redaction boxes without detection.

Available options:
detect,
burn,
auto

Response

Redaction job successfully queued.

​
ok
boolean
required

Indicates the job was accepted.

Example:

true

​
jobId
string<uuid>
required

Unique job identifier.

​
status
enum<string>
required

Initial job status.

Available options:
pending
​
outputS3Uri
string
required

S3 URI where the redacted file will be written after processing completes.

​
detectedType
enum<string>
required

Detected media type used to determine processing pipeline.

Available options:
video,
audio,
image,
text