Skip to content
docstack-ocr

Reprocess Document Job Endpoint

POST
/v1/documents/{job_id}/reprocess
 
curl --request POST \
  --url https://docstack.nvc.nxu.ae/v1/documents/example/reprocess \
  --header 'Content-Type: application/json' \
  --data '{ "template_id": "example", "clear_template": false, "output_mode": "example", "processing_mode": "example", "page_range": "example" }'

Re-enqueue any terminal-status job, optionally swapping templates.

Body is optional; {} keeps the existing template. See the ReprocessPayload docstring for the keep / clear / swap matrix.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
job_id
required
Job Id
string

Request Body

Section titled “Request Body ”
Media type application/json
Any of:
ReprocessPayload

Body for POST /v1/documents/{job_id}/reprocess.

Same auth-header keep/clear pattern as the infra-endpoints router:

  • template_id omitted (default None) → keep current.
  • clear_template: true → reset to auto-classify.
  • template_id set → swap.

The two cannot both be supplied (clear_template=true with a template_id); pydantic catches that with the validator below.

output_mode (omitted → keep current) is document or extraction. processing_mode is a deprecated compatibility alias.

page_range (omitted → keep the job’s current selection) re-selects PDF pages on re-run — e.g. narrow a job that failed “all pages” over the page cap to 1-3, or widen back to all.

object
template_id
Any of:
string
<= 64 characters
clear_template
Clear Template
boolean
output_mode
Any of:
string
processing_mode
Any of:
string
page_range
Any of:
string
<= 255 characters

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

Media type application/json
JobActionResponse
object
job_id
required
Job Id
string
status
required
Status
string
Allowed values: queued processing completed needs_review rejected failed
failure_code
Any of:
string
failure_message
Any of:
string
Example 
{
  "status": "queued"
}

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": {}
    }
  ]
}