Create run | Plextera Public Api

curl -X POST https://api.plextera.com/api/public/v1/workflows/workflowId/runs \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json"

{
  "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": "UNSUPPORTED_DOCUMENT",
    "message": "The document could not be processed by Document Insights."
  },
  "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": "UNSUPPORTED_DOCUMENT",
              "message": "The document could not be processed by Document Insights."
            },
            "workflow": {
              "id": "string",
              "name": "string"
            },
            "progress": {
              "stepsCompleted": 1,
              "stepsTotal": 1
            },
            "durationMs": 1,
            "computedDurationMs": 1,
            "steps": [
              null
            ]
          }
        ]
      }
    }
  ]
}

curl -X POST https://api.plextera.com/api/public/v1/workflows/workflowId/runs \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json"

{
  "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": "UNSUPPORTED_DOCUMENT",
    "message": "The document could not be processed by Document Insights."
  },
  "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": "UNSUPPORTED_DOCUMENT",
              "message": "The document could not be processed by Document Insights."
            },
            "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.

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

$	curl -X POST https://api.plextera.com/api/public/v1/workflows/workflowId/runs \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"id": "string",
3	"status": "PROCESSING",
4	"createdAt": "2024-01-15T09:30:00Z",
5	"updatedAt": "2024-01-15T09:30:00Z",
6	"startedAt": "2024-01-15T09:30:00Z",
7	"completedAt": "2024-01-15T09:30:00Z",
8	"error": {
9	"code": "UNSUPPORTED_DOCUMENT",
10	"message": "The document could not be processed by Document Insights."
11	},
12	"workflow": {
13	"id": "string",
14	"name": "string"
15	},
16	"progress": {
17	"stepsCompleted": 1,
18	"stepsTotal": 1
19	},
20	"durationMs": 1,
21	"computedDurationMs": 1,
22	"steps": [
23	{
24	"id": "string",
25	"name": "string",
26	"type": "string",
27	"status": "QUEUED",
28	"message": "string",
29	"output": null,
30	"nestedRuns": {
31	"count": 1,
32	"data": [
33	{
34	"id": "string",
35	"status": "PROCESSING",
36	"createdAt": "2024-01-15T09:30:00Z",
37	"updatedAt": "2024-01-15T09:30:00Z",
38	"startedAt": "2024-01-15T09:30:00Z",
39	"completedAt": "2024-01-15T09:30:00Z",
40	"error": {
41	"code": "UNSUPPORTED_DOCUMENT",
42	"message": "The document could not be processed by Document Insights."
43	},
44	"workflow": {
45	"id": "string",
46	"name": "string"
47	},
48	"progress": {
49	"stepsCompleted": 1,
50	"stepsTotal": 1
51	},
52	"durationMs": 1,
53	"computedDurationMs": 1,
54	"steps": [
55	null
56	]
57	}
58	]
59	}
60	}
61	]
62	}