API Category

Schemas

Schemas define extraction field contracts and allow teams to create, list, inspect, update, and delete schema definitions programmatically.

Business Use Case

Use these APIs to manage schema lifecycle across environments and keep extraction contracts consistent for downstream systems.

When To Use

You need to create or update extraction templates programmatically.
You need to inspect existing schema definitions by schema ID.
You need to retire deprecated schemas safely.

Endpoint Directory

GETList Schemas

/api/v1/schemas

POSTCreate Schema

/api/v1/schemas

DELETEDelete Schema

/api/v1/schemas/{schema_id}

GETGet Schema

/api/v1/schemas/{schema_id}

PUTUpdate Schema

/api/v1/schemas/{schema_id}

Endpoint Details

GET

List Schemas

List all available schemas, optionally filtered by document_type, schema_name, or client_id. Query Parameters: - document_type: Filter schemas by document type - schema_name: Filter schemas by schema name (may not be unique) - client_id: Filter schemas by client ID Note: schema_name is optional and may not be unique.

schemas

Endpoint URL

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

Overview

Purpose

List Schemas

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
document_type	unknown	Optional	-	-
schema_name	unknown	Optional	-	-
client_id	unknown	Optional	-	-

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/schemas";
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.

POST

Create Schema

Create Schema This endpoint is documented for production integration usage.

schemas

Endpoint URL

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

Overview

Create Schema This endpoint is documented for production integration usage.

Purpose

Create Schema

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

Field	Type	Required	Description	Example
schema_name	string	Required	Human-readable name for this schema	schema_name_value
document_type	string	Required	Document type this schema applies to	document_type_value
fields	object[]	Required	-	[{"name":"name_value","type":"string","description":"string_value","required":false}]
fields	object[]	Required	-	[{"name":"name_value","type":"string","description":"string_value","required":false}]
fields[].name	string	Required	-	name_value

Request Default

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

javascript

const url = "https://api.neudociq.com/api/v1/schemas";
const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "schema_name": "schema_name_value",
  "document_type": "document_type_value",
  "description": "string_value",
  "client_id": "string_value",
  "fields": [
    {
      "name": "name_value",
      "type": "string",
      "description": "string_value",
      "required": false
    }
  ],
  "transform_ids": [
    "string_value"
  ]
}),
});

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.

DELETE

Delete Schema

Delete a schema by ID.

schemas

Endpoint URL

https://api.neudociq.com/api/v1/schemas/{schema_id}

Overview

Delete a schema by ID.

Purpose

Delete Schema

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

Name	Type	Required	Description	Example
schema_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/schemas/{schema_id}";
const response = await fetch(url, {
  method: 'DELETE',
  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.

GET

Get Schema

Get a specific schema by ID (primary) or schema_name (fallback). Primary identification is via schema_id (string UUID). If schema_name is provided and exists, it will be used as fallback. Note: schema_name may not be unique, so schema_id is recommended.

schemas

Endpoint URL

https://api.neudociq.com/api/v1/schemas/{schema_id}

Overview

Purpose

Get Schema

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

No parameters.

Path Parameters

Name	Type	Required	Description	Example
schema_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/schemas/{schema_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.

PUT

Update Schema

Update an existing extraction schema by ID.

schemas

Endpoint URL

https://api.neudociq.com/api/v1/schemas/{schema_id}

Overview

Update an existing extraction schema by ID.

Purpose

Update Schema

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

Name	Type	Required	Description	Example
schema_id	string	Required	-	-

Request Fields

Field	Type	Required	Description	Example
schema_name	string	Required	Human-readable name for this schema	schema_name_value
document_type	string	Required	Document type this schema applies to	document_type_value
fields	object[]	Required	-	[{"name":"name_value","type":"string","description":"string_value","required":false}]
fields	object[]	Required	-	[{"name":"name_value","type":"string","description":"string_value","required":false}]
fields[].name	string	Required	-	name_value

Request Default

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

javascript

const url = "https://api.neudociq.com/api/v1/schemas/{schema_id}";
const response = await fetch(url, {
  method: 'PUT',
  headers: {
    'X-API-Key': 'ndq_test_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "schema_name": "schema_name_value",
  "document_type": "document_type_value",
  "description": "string_value",
  "client_id": "string_value",
  "fields": [
    {
      "name": "name_value",
      "type": "string",
      "description": "string_value",
      "required": false
    }
  ],
  "transform_ids": [
    "string_value"
  ]
}),
});

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.