Skip to content
docstack-ocr

Delete Document Job Endpoint

DELETE
/v1/documents/{job_id}
 
curl --request DELETE \
  --url http://localhost:8080/v1/documents/example

Soft-delete a terminal-status job. Idempotent.

Refuses queued / processing (cancel first). Closes any open review_queue row with status='closed_by_delete' so reviewers can’t act on a deleted job. The artifact remains in storage; a separate purge cron hard-deletes after the configured grace window (see plan §B8).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
job_id
required
Job Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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