Groundeddocs
ReferenceAdmin

Replace the platform's parsing settings (platform admins; audited)

PUT/v1/admin/parsing

400 invalid_languages, invalid_backend, invalid_model (visionModelId is not a vision model) or backend_not_configured (OCR turned on with a backend that isn't configured, or the vision backend without a model).

Header Parameters

If-Match*string

The resource's revision, as returned in ETag (for example "3"). Missing returns 428; stale returns 412.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/admin/parsing" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "ocrEnabled": true,    "backend": "tesseract",    "visionModelId": "e0f7bd69-1018-443d-a7be-69ce51b98dde",    "languages": "eng+spa"  }'
{  "data": {    "ocrEnabled": true,    "backend": "tesseract",    "visionModelId": "e0f7bd69-1018-443d-a7be-69ce51b98dde",    "languages": "string",    "backends": [      {        "backend": "tesseract",        "configured": true,        "configuredBy": "string"      }    ],    "maxPagesPerDocument": 0,    "concurrency": 0,    "needsOcr": [      {        "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",        "teamSlug": "string",        "teamName": "string",        "documents": 0      }    ],    "revision": 0,    "updatedAt": "2019-08-24T14:15:22Z"  }}