Skip to content
docstack-ocr

List Document Jobs Endpoint

GET
/v1/documents
 
curl --request GET \
  --url 'https://docstack.nvc.nxu.ae/v1/documents?include_deleted=false&limit=50&offset=0'

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
Any of:
string
Allowed values: queued processing completed needs_review rejected failed
template_id
Any of:
string
template_name
Any of:
string
since
Any of:
string format: date-time
until
Any of:
string format: date-time
q
Any of:
string
include_deleted
Include Deleted
boolean
limit
Limit
integer
default: 50
offset
Offset
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
JobListResponse
object
items
required
Items
Array<object>
JobListItem

Thinner shape than the by-id response — listing is a navigation aid.

object
job_id
required
Job Id
string
status
required
Status
string
Allowed values: queued processing completed needs_review rejected failed
source_format
required
Source Format
string
Allowed values: image pdf vector office
page_count
required
Page Count
integer
vision_profile
required
Vision Profile
string
output_mode
required
Output Mode
string
Allowed values: document extraction
processing_mode
required
Processing Mode

Deprecated compatibility projection: canonical maps to output_mode=document; extraction maps unchanged. Historical audit rows may retain a retired value and are read-only.

string
requested_template_id
required
Any of:
string
requested_template_name
required
Any of:
string
resolved_template_id
required
Any of:
string
resolved_template_version
required
Any of:
integer
review_decision
required
Any of:
string
Allowed values: accept review reject
review_reasons
required
Review Reasons
Array<string>
failure_code
required
Any of:
string
failure_message
required
Any of:
string
created_at
required
Created At
string
completed_at
required
Any of:
string
deleted_at
Any of:
string
legal_hold
Legal Hold
boolean
online_purge_status
Online Purge Status
string
default: not_requested
online_purge_deadline
Any of:
string
backup_deletion_status
Backup Deletion Status
string
default: not_requested
backup_deletion_deadline
Any of:
string
total
required
Total
integer
limit
required
Limit
integer
offset
required
Offset
integer
Example 
{
  "items": [
    {
      "status": "queued",
      "source_format": "image",
      "output_mode": "document",
      "review_decision": "accept",
      "legal_hold": false,
      "online_purge_status": "not_requested",
      "backup_deletion_status": "not_requested"
    }
  ]
}

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