PATCH /v1/files/{file_id}/processing-policy

← API referenceFile intelligence · API access unavailable

API REFERENCE / FILE INTELLIGENCE

`PATCH` /v1/files/{file_id}/processing-policy

Update which post-processing outputs are enabled for a file.

Request fields

Location	Field	Type	Required	Description
Header	`Authorization`	string	Yes	Credential scoped to the authorized resource.
Header	`Content-Type`	string (media type)	Yes	application/json.
Path	`file_id`	string	Yes	Stable Atom file ID.
Header	`Idempotency-Key`	string	Yes	Stable retry identity.
Body	`expected_policy_revision`	string	Yes	Revision returned by the processing report.
Body	`outputs`	string	Yes	Output kinds to enable or disable for this file.
Body	`outputs[].kind`	string (extensible)	No	Processor kind within each output entry. Examples · extensible`thumbnailpage_ocrtranscriptpage_summarydocument_summaryface_detection`
Body	`outputs[].enabled`	string	No	Whether that processor should run automatically.

Request example

Example request

PATCH /v1/files/file_789/processing-policy
Authorization: Bearer <analysis-manage token>
Idempotency-Key: policy-8427
Content-Type: application/json

{
  "expected_policy_revision": "proc_rev_007",
  "outputs": [
    {
      "kind": "page_summary",
      "enabled": false
    }
  ]
}

HTTP status codes

Status	Meaning
`202 Accepted`	Success response shown below.
`400 Bad Request`	Invalid output kind or policy.
`401 Unauthorized`	Missing, expired, or invalid credential.
`403 Forbidden`	Credential is valid but lacks the required scope or role.
`404 Not Found`	File is not visible to this caller.
`409 Conflict`	Policy revision changed or idempotency key was reused with different input.
`429 Too Many Requests`	Rate limit reached; honor Retry-After when provided.
`503 Service Unavailable`	Service temporarily unavailable; retry safely.

Response fields

Field	Type	Example
`operation_id`	string	op_601
`file_id`	string	file_789
`status`	string	accepted
`expected_policy_revision`	string	proc_rev_007

Response example

Example response

202 Accepted
Content-Type: application/json

{
  "operation_id": "op_601",
  "file_id": "file_789",
  "status": "accepted",
  "expected_policy_revision": "proc_rev_007"
}

How it works

This is an owner-authorized, expected-revision change. Disabling an output stops future automatic generation but does not silently erase existing artifacts; use artifact deletion for removal. Sensitive analysis such as face detection requires separate explicit owner consent.