Skip to main content
POST
/
files
/
{id}
/
redact
POST /files/{id}/redact
curl --request POST \
  --url https://api.indoralabs.com/files/{id}/redact \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "targets": "<string>",
  "sampleFps": 15
}
'
{
  "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

The unique file ID to redact.

Body

application/json
​
targets
string

Comma-separated list of redaction targets (e.g. faces,plates,pii).

​
sampleFps
integer

Optional frame sampling rate for video redaction. Controls processing speed vs. accuracy.

Required range: 1 <= x <= 30

Response

Redaction job accepted and queued for processing.

​
ok
boolean

Indicates that the request was successfully queued.

Example:

true

​
jobId
string<uuid>

Unique identifier for the redaction job.

​
status
enum<string>

Initial job status.

Available options:
pending
​
outputS3Uri
string

S3 URI where the redacted output will be written once processing completes.

​
detectedType
enum<string>

Detected file media type that determined which redaction pipeline to run.

Available options:
video,
audio,
image,
text