Get job | Plextera Public API

curl https://api.dev.plextera.com/api/public/v1/document-insights/jobs/jobId \
     -H "Authorization: <apiKey>"

{
  "id": "string",
  "operation": "parse",
  "status": "QUEUED",
  "outputAvailable": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "startedAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z",
  "error": {
    "code": "string",
    "message": "string"
  },
  "hubId": "string",
  "hubName": "string",
  "metadata": {},
  "document": {
    "fileId": "string",
    "fileName": "string",
    "mimeType": "string",
    "sizeBytes": 1,
    "pageCount": 1
  },
  "output": {
    "fieldCount": 1,
    "fields": [
      {
        "id": "string",
        "name": "string",
        "type": "text",
        "value": null,
        "metadata": {
          "extracted": true,
          "confidence": 1.1,
          "page": 1,
          "placement": {
            "x": 1,
            "y": 1,
            "width": 1,
            "height": 1
          },
          "customOrderProperty": null
        }
      }
    ]
  }
}

Authentication

Authorizationstring

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

Path parameters

jobIdstringRequired

Response

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.

outputobject

Final job output. Parse jobs return MarkdownOutput; extract jobs return ExtractionOutput.