Skip to content
docstack-ocr

Patch Tenant Policy

PATCH
/v1/admin/tenant-policy/{tenant_id}
 
curl --request PATCH \
  --url http://localhost:8080/v1/admin/tenant-policy/example \
  --header 'Content-Type: application/json' \
  --data '{ "auto_classify_enabled": true, "default_template_id": "example", "review_agreement_floor": 1, "review_confidence_floor": 1, "review_warn_count_threshold": 1, "rate_limit_per_minute": 1, "pdf_max_pages": 1, "pptx_notes_mode": "margin", "characterisation_enabled": true, "generic_entities_enabled": true, "judge_mode_enabled": true, "table_aware_extraction_enabled": true, "draft_on_miss_enabled": true, "extraction_postprocessing_enabled": true, "extraction_evidence_planning_enabled": true, "extraction_chunk_merge_strategy": "field_aware", "tax_id_country_prefix_mode": "infer", "feature_flags": {}, "forge_enabled": true, "tenant_infra_overrides_enabled": true, "forge_monthly_token_quota": 1, "forge_monthly_dollar_quota": 1, "forge_per_job_max_iterations": 1, "forge_per_job_max_dollars": 1, "forge_per_job_max_wall_seconds": 1, "ocr_selection_mode": "paddle_priority", "ocr_priority_margin": 1, "layout_policy": {}, "glm_risk_policy": {}, "prompt_budget_policy": {}, "language_policy": {}, "preprocessing_policy": {} }'

Partial update. Keys present in the request body are applied; null values clear inheritable columns so the next read inherits from platform defaults. Keys absent from the body leave columns untouched. Non-inheritable fields (kill switches, feature_flags) reject explicit null with 422.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tenant_id
required
Tenant Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
TenantPolicyPayload
object
auto_classify_enabled
Any of:
boolean
default_template_id
Any of:
string
review_agreement_floor
Any of:
number
<= 1
review_confidence_floor
Any of:
number
<= 1
review_warn_count_threshold
Any of:
integer
>= 1
rate_limit_per_minute
Any of:
integer
>= 1
pdf_max_pages
Any of:
integer
>= 1
pptx_notes_mode
Any of:
string
Allowed values: margin pages off
characterisation_enabled
Any of:
boolean
generic_entities_enabled
Any of:
boolean
judge_mode_enabled
Any of:
boolean
table_aware_extraction_enabled
Any of:
boolean
draft_on_miss_enabled
Any of:
boolean
extraction_postprocessing_enabled
Any of:
boolean
extraction_evidence_planning_enabled
Any of:
boolean
extraction_chunk_merge_strategy
Any of:
string
Allowed values: field_aware legacy
tax_id_country_prefix_mode
Any of:
string
Allowed values: infer preserve off
feature_flags
Any of:
object
key
additional properties
any
forge_enabled
Any of:
boolean
tenant_infra_overrides_enabled
Any of:
boolean
forge_monthly_token_quota
Any of:
integer
forge_monthly_dollar_quota
Any of:
number
forge_per_job_max_iterations
Any of:
integer
>= 1
forge_per_job_max_dollars
Any of:
number
> 0
forge_per_job_max_wall_seconds
Any of:
integer
>= 60
ocr_selection_mode
Any of:
string
Allowed values: paddle_priority glm_priority confidence_based
ocr_priority_margin
Any of:
number
<= 1
layout_policy
Any of:
object
key
additional properties
any
glm_risk_policy
Any of:
object
key
additional properties
any
prompt_budget_policy
Any of:
object
key
additional properties
any
language_policy
Any of:
object
key
additional properties
any
preprocessing_policy
Any of:
object
key
additional properties
any

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Response Patch Tenant Policy V1 Admin Tenant Policy Tenant Id Patch
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}