Create extract job | Plextera Public API

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Request

This endpoint expects an object.

documentobjectRequired

hubIdstringOptionalformat: "^[0-9a-fA-F]{24}$"=24 characters

Optional Document Insights hub identifier. Omit hubId to let Document Insights route the job automatically using metadata or default hub configuration.

metadatamap from strings to stringsOptional

Client-provided string metadata echoed back on the job for correlation and reconciliation. Keys and values must be non-empty strings. Maximum: 50 entries, 64 characters per key, 512 characters per value. When hubId is omitted, Document Insights may also use metadata to determine the extraction hub.

Response

Accepted

idstring

operationenum

Allowed values:

statusenum

Allowed values:

outputAvailableboolean

createdAtdatetime

updatedAtdatetime

startedAtdatetime

completedAtdatetime

errorobject

Terminal failure details. Present only for failed or rejected jobs and runs.

hubIdstring

hubNamestring

metadatamap from strings to strings

documentobject

Document summary used inside Document Insights job and event payloads. Page count is reported only when known by the source document metadata.

1	curl -X POST https://api.dev.plextera.com/api/public/v1/document-insights/jobs/extract \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"document": {
6	"fileId": "string"
7	}
8	}'

1	{
2	"id": "string",
3	"operation": "parse",
4	"status": "QUEUED",
5	"outputAvailable": true,
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"startedAt": "2024-01-15T09:30:00Z",
9	"completedAt": "2024-01-15T09:30:00Z",
10	"error": {
11	"code": "string",
12	"message": "string"
13	},
14	"hubId": "string",
15	"hubName": "string",
16	"metadata": {},
17	"document": {
18	"fileId": "string",
19	"fileName": "string",
20	"mimeType": "string",
21	"sizeBytes": 1,
22	"pageCount": 1
23	}
24	}