> This page is for version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.plextera.com/v-1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.plextera.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.plextera.com/_mcp/server.

# Get run

GET https://api.plextera.com/api/public/v1/workflow-runs/{runId}

Returns one workflow run with step output. Terminal statuses are `COMPLETED`, `FAILED`, and `CLOSED`.

Reference: https://docs.plextera.com/api/api-reference/workflows/get-workflow-run

## Authentication

- `Authorization` header (required) — Use the API key format: `api-key <token>`.

## Request

### Path parameters

- `runId` (string, required) — Run identifier returned by Create run.

## Response

### 200

Current run state with step-level output.

- `id` (string, optional) — Run identifier. Use it with GET /workflow-runs/\{runId} and event correlation.
- `status` (enum, optional) — Current run state. Stop polling on `COMPLETED`, `FAILED`, or `CLOSED`.
  - Allowed values: `PROCESSING`, `COMPLETED`, `FAILED`, `CLOSED`
- `createdAt` (datetime, optional) — UTC timestamp when the run was accepted.
- `updatedAt` (datetime, optional) — UTC timestamp of the latest known state change.
- `startedAt` (datetime, optional) — UTC timestamp when execution started.
- `completedAt` (datetime, optional) — UTC timestamp when the run reached a terminal state. Omitted while it is still processing.
- `error` (RunError, optional) — Failure details. Present only for failed runs.
- `workflow` (WorkflowSummary, optional) — The workflow this run belongs to.
- `progress` (WorkflowRunProgress, optional) — Step completion progress.
- `durationMs` (long, optional) — Wall-clock duration from createdAt to completedAt in milliseconds. Omitted until the run is terminal.
- `computedDurationMs` (long, optional) — Active processing time in milliseconds reported by Studio, excluding wait states and idle time in parallel branches. May be omitted from list summaries.
- `steps` (list of WorkflowRunStep, optional) — Executed steps with their public output.

## Errors

### 400 Bad Request Error

INVALID_REQUEST — The request is malformed: unreadable JSON, an invalid parameter value, or a bad multipart body.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 401 Unauthorized Error

UNAUTHORIZED — The API key is missing, malformed, or revoked.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 403 Forbidden Error

FORBIDDEN — The API key is valid but not allowed to perform this operation.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 404 Not Found Error

NOT_FOUND — The resource does not exist in your workspace.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 405 Method Not Allowed Error

METHOD_NOT_ALLOWED — The HTTP method is not supported for this path.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 406 Not Acceptable Error

NOT_ACCEPTABLE — The requested response media type is not supported.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 409 Conflict Error

CONFLICT — The request conflicts with existing state in an upstream Plextera service.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 429 Too Many Requests Error

RATE_LIMITED — Too many requests in a short window. 429 responses are enforced at the network edge; the body may be plain text instead of this envelope, so rely on the status code and the Retry-After header.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 500 Internal Server Error

INTERNAL_ERROR — Unexpected failure inside Plextera. Retry with backoff; contact support with the requestId if it persists.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

### 502 Bad Gateway Error

DOWNSTREAM_ERROR — A downstream Plextera service failed while handling the request. Retry with backoff.

- `error` (ApiError, optional) — Machine-readable error details shared by every error response.

## Types

### RunError

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

- `code` (string, optional) — Stable machine-readable reason code. Document Insights returns `DOCUMENT_NOT_ROUTED` with `FAILED` for routing problems, `DOCUMENT_EXTRACTION_FAILED` with `FAILED` for processing or extracted-data validation problems, and `DOCUMENT_REJECTED` with `REJECTED` for document-level problems such as duplicate content or an unsupported language.
- `message` (string, optional) — Human-readable explanation of the failure or rejection.

### WorkflowSummary

The workflow a run belongs to.

- `id` (string, optional) — Workflow identifier configured in Plextera Studio.
- `name` (string, optional) — Human-readable workflow name.

### WorkflowRunProgress

Step completion progress of a run.

- `stepsCompleted` (integer, optional) — Steps that finished (completed or skipped).
- `stepsTotal` (integer, optional) — Total steps in the workflow.

### WorkflowRunStep

One executed workflow step with its public output.

- `id` (string, optional) — Step identifier within the workflow definition.
- `name` (string, optional) — Step name configured in Plextera Studio.
- `type` (string, optional) — Step type, for example `document_insights` or `web_function`.
- `status` (enum, optional) — Execution state of this step.
  - Allowed values: `QUEUED`, `PROCESSING`, `COMPLETED`, `FAILED`, `SKIPPED`
- `message` (string, optional) — Step-level diagnostic message, when available.
- `output` (map from string to any, optional) — Step-specific output passed through from Plextera Studio. Its shape, property names, and enum casing depend on the step type and may evolve with Studio; for example, an internal media-type enum such as APPLICATION\_PDF may appear here while typed public API fields use the standard application/pdf MIME value. For document\_insights steps, extractionId is the stable correlation field; use it with GET /document-insights/extractions/\{extractionId} for the canonical, typed extraction response.
- `nestedRuns` (NestedWorkflowRuns, optional) — Nested workflow runs started by this step. Items may include full nested step output, and GET /workflow-runs/\{runId} can load or refresh full nested run output by id.

### ApiError

Machine-readable error details shared by every error response.

- `code` (string, optional) — Stable machine-readable error code. Branch your handling on this, not on `message`.
- `message` (string, optional) — Human-readable explanation. Wording may change; do not parse it.
- `requestId` (string, optional) — Unique request identifier, also returned in the X-Request-Id response header. Include it in support requests.
- `retryable` (boolean, optional) — True when retrying the same request later may succeed.
- `details` (list of ApiErrorDetail, optional) — Field-level validation issues. Present only for VALIDATION_FAILED.

### NestedWorkflowRuns

Nested workflow runs started by a step. Items may include the same full step output structure as a top-level workflow run. Use GET /workflow-runs/\{runId} to load or refresh full nested run output by id.

- `count` (integer, optional) — Number of nested runs started by the step.
- `data` (list of WorkflowNestedRun, optional) — The nested runs.

### ApiErrorDetail

Field-level validation issue.

- `field` (string, optional) — Name of the invalid request field.
- `issue` (string, optional) — What is wrong with the field value.

### WorkflowNestedRun

Nested workflow run. When available, steps include the full public output for each nested step.

- `id` (string, optional)
- `status` (enum, optional)
  - Allowed values: `PROCESSING`, `COMPLETED`, `FAILED`, `CLOSED`
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)
- `startedAt` (datetime, optional)
- `completedAt` (datetime, optional)
- `error` (RunError, optional) — Terminal failure details. Present only for failed or rejected extractions and workflow runs.
- `workflow` (WorkflowSummary, optional) — The workflow a run belongs to.
- `progress` (WorkflowRunProgress, optional) — Step completion progress of a run.
- `durationMs` (long, optional)
- `computedDurationMs` (long, optional)
- `steps` (list of WorkflowRunStep, optional) — Nested run steps with the same step-level output structure as a top-level workflow run.

## Examples

**Response**

```json
{
  "id": "69d224901610662a576cd7e6",
  "status": "COMPLETED",
  "createdAt": "2026-04-07T10:05:04Z",
  "updatedAt": "2026-04-07T10:07:31Z",
  "startedAt": "2026-04-07T10:05:05Z",
  "completedAt": "2026-04-07T10:07:31Z",
  "workflow": {
    "id": "invoice-processing",
    "name": "Invoice Processing"
  },
  "progress": {
    "stepsCompleted": 1,
    "stepsTotal": 1
  },
  "durationMs": 146000,
  "computedDurationMs": 142000,
  "steps": [
    {
      "id": "step_01",
      "name": "Extract Invoice",
      "type": "document_insights",
      "status": "COMPLETED",
      "output": {
        "document": {
          "fileName": "invoice.pdf",
          "id": "69d224901610662a576cd800",
          "mimeType": "APPLICATION_PDF",
          "size": 126,
          "source": "DOCUMENT_INSIGHTS"
        },
        "extractionId": "69654f0bc073ef404baec649",
        "fields": [
          {
            "id": "605c644cbf48241234f62121",
            "name": "vendorName",
            "type": "TEXT",
            "value": "Acme Industries Ltd"
          }
        ],
        "fileName": "invoice.pdf",
        "metaAttributes": {
          "recordId": "69654f0bc073ef404baec649"
        }
      },
      "nestedRuns": {
        "count": 0,
        "data": []
      }
    }
  ]
}
```

**SDK Code**

```python Completed run
import requests

url = "https://api.plextera.com/api/public/v1/workflow-runs/runId"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Completed run
const url = 'https://api.plextera.com/api/public/v1/workflow-runs/runId';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Completed run
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plextera.com/api/public/v1/workflow-runs/runId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Completed run
require 'uri'
require 'net/http'

url = URI("https://api.plextera.com/api/public/v1/workflow-runs/runId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Completed run
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.plextera.com/api/public/v1/workflow-runs/runId")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php Completed run
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.plextera.com/api/public/v1/workflow-runs/runId', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Completed run
using RestSharp;

var client = new RestClient("https://api.plextera.com/api/public/v1/workflow-runs/runId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Completed run
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.plextera.com/api/public/v1/workflow-runs/runId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```