/api/v1/config

Updates the service configuration in memory. The config_json_string field contains, serialized as a JSON string, the parameters to modify; those not included keep their value.

Not all the parameters returned by GET /api/v1/config can be modified with this endpoint. The following table shows the access level of each one:

Parameter	Access
config_path	Read and write
templates_path	Read and write
document_interpreter_version	Read and write
document_interpreter_use_universal	Read and write
global_threads_pool_size	Read and write
max_inference_threads	Read and write
ocr_latin_batch_size	Read and write
metrics_saturation_queue_p95_ms	Read and write
metrics_saturation_min_inflight_ratio	Read and write
metrics_error_rate_warning	Read and write
metrics_idle_rps_threshold	Read and write
metrics_quality_alert_window_seconds	Read and write
port	Read-only
number_of_threads	Read-only
connection_timeout	Read-only
keep_alive_request_number	Read-only
client_max_body_size	Read-only
logger_path	Read-only
logger_file_prefix	Read-only
logger_level	Read-only
logger_rotation	Read-only
logger_max_files	Read-only
metrics_enabled	Read-only
processor_threads_pool_size	Read-only
pipeline_threads_pool_size	Read-only

• Read-write parameters are applied without restarting the service. If the equivalent environment variable is defined (for example, FACEPHI_OCR_REST_METRICS_ERROR_RATE_WARNING), its value takes precedence over the one sent.

• config_path reloads the models from <config_path>/models. templates_path changes the templates of the version 1 interpreter and of invoice processing; the version 2 interpreter and /api/v1/process_multi keep using the templates loaded at startup.

• Each successful update reloads the processing models, so it is recommended to perform it when the service is not processing documents.

• The metrics_* parameters are the thresholds GET /api/v1/metrics uses to classify the service status.

• Read-only parameters are only configured at startup, through config.json or the FACEPHI_OCR_REST_* environment variables. If they are sent to this endpoint, the request responds 200 and GET returns the value sent, but the service keeps using the value it started with.

• GET returns the values defined in config.json and those sent to this endpoint; it does not reflect values set through environment variables.

• Changes are not saved to config.json and are lost when the service restarts.

• JWT authentication settings (auth_*) are startup-only: GET does not return them and this endpoint rejects with 400 the requests that include them.

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

Body for the configuration request. This endpoint does not accept JWT authentication settings.

config_json_stringstringObrigatório

JSON string with the configuration parameters to modify. Only the read-write parameters listed in POST /api/v1/config are applied.

Example: {"document_interpreter_version":2,"document_interpreter_use_universal":1}

Respostas

200

Message with the result of the operation.

application/json

messagestringOpcionalExample: Configuration updated successfully

400

Incorrect parameters were received in the request.

application/json

500

An error occurred in the call to the OCR-SDK backend.

application/json

post/api/v1/config

POST /api/v1/config HTTP/1.1
Host: 127.0.0.1:6982/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "config_json_string": "{\"document_interpreter_version\":2,\"document_interpreter_use_universal\":1}"
}

{
  "message": "Configuration updated successfully"
}