API Category

Extract

Extract endpoints transform parsed content into structured fields, optionally with citations, metadata, and normalization outputs.

Business Use Case

Use extraction APIs when your downstream systems need machine-readable fields from invoices, KYC forms, contracts, or public-sector records.

When To Use

  • You have a known schema for specific document families.
  • You need bounding-box citation anchors for audit trails.
  • You need selective field extraction with deterministic outputs.

Endpoint Directory

Endpoint Details

POST

Extract Document

Extract structured fields from a document using your schema so downstream systems can consume validated, machine-readable output.

extract

Endpoint URL

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

Overview

Extract structured fields from a document using your schema so downstream systems can consume validated, machine-readable output.

Purpose

Extract Document

Use Case

Use this endpoint as part of your document processing workflow where the operation path is required.

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/extract";
const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "document_id": "string_value",
  "document_url": "string_value",
  "schema_id": "string_value",
  "schema_definition": {},
  "select_pages": 1,
  "maintain_format": true,
  "force_layout_extraction": false,
  "enable_citations": true,
  "response_options": {
    "include_citations": true,
    "include_extraction_metadata": true,
    "include_raw_extracted": true,
    "include_normalized": true
  }
}),
});

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.