API Category

Batches

Batch APIs run extraction workloads at scale with job creation, status tracking, and public batch listing for operational visibility.

Business Use Case

Use batch workflows for large nightly processing jobs, backfills, or scheduled enterprise/government imports.

When To Use

You need asynchronous multi-document processing.
You need progress tracking for extraction jobs.
You need a public status lifecycle for asynchronous processing.

Endpoint Directory

GETList Batch Jobs

/api/v1/batch

GETGet Batch Status

/api/v1/batch/{batch_id}

POSTCreate Batch Extraction

/api/v1/batch/extract

Endpoint Details

GET

List Batch Jobs

Retrieve batch jobs with pagination and optional status filtering, including progress and lifecycle details for operational monitoring.

batch

Endpoint URL

https://api.neudociq.com/api/v1/batch

Overview

Retrieve batch jobs with pagination and optional status filtering, including progress and lifecycle details for operational monitoring.

Purpose

List Batch Jobs

Use Case

This endpoint is read-only and should be safe to call repeatedly for the same resource identifier.

Authentication

APIKeyHeader: API key in header (X-API-Key).

Header Example

http

X-API-Key: ndq_test_api_key

Headers

No parameters.

Query Parameters

Name	Type	Required	Description	Example
status	unknown	Optional	Filter by batch status	-
page	integer	Optional	Page number (1-indexed)	-
page_size	integer	Optional	Items per page	-

Path Parameters

No parameters.

Request Fields

No request body fields are defined for this endpoint.

Request Default

Copy-ready examples with real endpoint paths and authentication placeholders.

javascript

const url = "https://api.neudociq.com/api/v1/batch";
const response = await fetch(url, {
  method: 'GET',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
  },
});

const data = await response.json();
console.log(data);

Best Practices

Validate required fields client-side before sending requests.
Log request identifiers and HTTP status codes for supportability.
Retry only when the operation is safe or your workflow is idempotent.
Poll status endpoints with backoff and stop polling once the batch reaches a terminal state.

GET

Get Batch Status

Fetch the latest status and progress for a specific batch job, including processing state, counts, and completion signals.

batch

Endpoint URL

https://api.neudociq.com/api/v1/batch/{batch_id}

Overview

Fetch the latest status and progress for a specific batch job, including processing state, counts, and completion signals.

Purpose

Get Batch Status

Use Case

This endpoint is read-only and should be safe to call repeatedly for the same resource identifier.

Authentication

APIKeyHeader: API key in header (X-API-Key).

Header Example

http

X-API-Key: ndq_test_api_key

Headers

No parameters.

Query Parameters

Name	Type	Required	Description	Example
include_documents	boolean	Optional	Include detailed status of all documents in the batch	-

Path Parameters

Name	Type	Required	Description	Example
batch_id	string	Required	-	-

Request Fields

No request body fields are defined for this endpoint.

Request Default

Copy-ready examples with real endpoint paths and authentication placeholders.

javascript

const url = "https://api.neudociq.com/api/v1/batch/{batch_id}";
const response = await fetch(url, {
  method: 'GET',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
  },
});

const data = await response.json();
console.log(data);

Best Practices

Validate required fields client-side before sending requests.
Log request identifiers and HTTP status codes for supportability.
Retry only when the operation is safe or your workflow is idempotent.
Poll status endpoints with backoff and stop polling once the batch reaches a terminal state.

POST

Create Batch Extraction

Create Batch Extraction This endpoint is documented for production integration usage.

batch

Endpoint URL

https://api.neudociq.com/api/v1/batch/extract

Overview

Create Batch Extraction This endpoint is documented for production integration usage.

Purpose

Create Batch Extraction

Use Case

Batch endpoints are asynchronous; create the job first, then use status and list endpoints to monitor completion.

Authentication

APIKeyHeader: API key in header (X-API-Key).

Header Example

http

X-API-Key: ndq_test_api_key

Headers

No parameters.

Query Parameters

No parameters.

Path Parameters

No parameters.

Request Fields

No request body fields are defined for this endpoint.

Request Default

Copy-ready examples with real endpoint paths and authentication placeholders.

javascript

const url = "https://api.neudociq.com/api/v1/batch/extract";
const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "documents": [
    {
      "document_id": "string_value",
      "document_url": "string_value",
      "metadata": {}
    }
  ],
  "storage_path": "string_value",
  "query": {},
  "schema_id": "string_value",
  "document_type": "string_value",
  "select_pages": 1,
  "maintain_format": true,
  "max_concurrent": 1,
  "priority": 0,
  "webhook_url": "string_value",
  "client_id": "string_value",
  "file_pattern": "string_value",
  "use_regex": false,
  "max_documents": 1,
  "skip_if_already_extracted": false
}),
});

const data = await response.json();
console.log(data);

Best Practices

Validate required fields client-side before sending requests.
Log request identifiers and HTTP status codes for supportability.
Retry only when the operation is safe or your workflow is idempotent.
Poll status endpoints with backoff and stop polling once the batch reaches a terminal state.