Create run | Plextera Public API

curl -X POST https://api.dev.plextera.com/api/public/v1/workflows/workflowId/runs \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: multipart/form-data" \
     -F document=@<file1>

{
  "id": "string",
  "status": "PROCESSING",
  "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"
  },
  "workflow": {
    "id": "string",
    "name": "string"
  },
  "progress": {
    "stepsCompleted": 1,
    "stepsTotal": 1
  },
  "durationMs": 1,
  "computedDurationMs": 1,
  "steps": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "status": "QUEUED",
      "message": "string",
      "output": null,
      "nestedRuns": {
        "count": 1,
        "data": [
          {
            "id": "string",
            "status": "PROCESSING",
            "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"
            },
            "workflow": {
              "id": "string",
              "name": "string"
            },
            "progress": {
              "stepsCompleted": 1,
              "stepsTotal": 1
            },
            "durationMs": 1,
            "computedDurationMs": 1,
            "steps": [
              null
            ]
          }
        ]
      }
    }
  ]
}

Authentication

Authorizationstring

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

Path parameters

workflowIdstringRequired

Request

Workflow trigger payload. Send application/json for normal JSON input, or multipart/form-data when the workflow needs form-data semantics. Multipart text and JSON parts are forwarded by their original part names. Multipart file parts are uploaded to Plextera File Service and exposed under the same part names as file-node arrays.

payloadmap from strings to anyOptional

Optional JSON part for workflow-specific input. Use when the workflow expects body.payload.

metadatamap from strings to stringsOptional

Optional JSON metadata part for client correlation or routing data.

documentfileOptional

Single document file part. Use this when the workflow expects body.document.

attachmentsfilesOptional

One or more file parts. Use this when the workflow expects body.attachments.

Response

Accepted

idstring

statusenum

Allowed values:

createdAtdatetime

updatedAtdatetime

startedAtdatetime

completedAtdatetime

errorobject

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

workflowobject

progressobject

durationMslong

computedDurationMslong

stepslist of objects