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

# Get Workflow Status

GET https://api.markup.ai/agents/workflows/{workflow_id}

Get workflow status and result.

Reference: https://docs.markup.ai/developer-reference/api-reference/agent-workflows/get-workflow-status

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `workflow_id` (string, required)

## Response

### 200

Successful Response

- `workflow_id` (string, required) — Workflow ID
- `status` (enum, required) — Current status
  - Allowed values: `running`, `completed`, `failed`, `timed_out`, `cancelled`
- `started_at` (datetime, required) — Start time
- `agent_id` (string, optional, default: ) — Agent that ran this workflow
- `document_ref` (string, optional, nullable) — Caller-provided document identifier.
- `check_type` (enum, optional) — How this check is counted: 'batch' for a document checked as part of a batch, 'interactive' for a direct /run check.
  - Allowed values: `interactive`, `automated`, `batch`, `baseline`
- `assigned` (boolean, optional, default: true) — Whether the check counts as authoring activity for an author.
- `batch_id` (string, optional, nullable) — Owning batch id (agbw\_\<nanoid>); null unless this is a batch check.
- `result` (map from string to any, optional, nullable) — Result (if completed)
- `completed_at` (datetime, optional, nullable) — Workflow completion time

## Errors

### 401 Unauthorized Error

Authentication failed or no valid API key provided.

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

### 403 Forbidden Error

Forbidden

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

### 404 Not Found Error

Workflow not found

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 500 Internal Server Error

Failed to retrieve workflow status

- `detail` (string, required) — A description of the error that occurred.
- `status` (integer, required) — The HTTP status code generated by the server for this issue
- `request_id` (string, required) — A unique ID associated with the HTTP request.

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ValidationErrorLocItems

- string
- integer

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "workflow_id": "agwf_7xK2mNpQrT9vLcBd",
  "status": "completed",
  "started_at": "2024-06-12T10:15:00Z",
  "agent_id": "agt_3hJwYnFsXe5mRkPz",
  "document_ref": "doc_article_homepage_v3",
  "check_type": "interactive",
  "assigned": true,
  "batch_id": "string",
  "result": {},
  "completed_at": "2024-06-12T10:15:42Z"
}
```

**SDK Code**

```python Python
import requests

response = requests.get(
    "https://api.markup.ai/agents/workflows/YOUR_WORKFLOW_ID",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
)
print(response.json())

```

```typescript TypeScript
const response = await fetch(
  "https://api.markup.ai/agents/workflows/YOUR_WORKFLOW_ID",
  {
    headers: { Authorization: "Bearer YOUR_TOKEN" },
  },
);
console.log(await response.json());

```

```go
package main

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

func main() {

	url := "https://api.markup.ai/agents/workflows/workflow_id"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

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

}
```

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

url = URI("https://api.markup.ai/agents/workflows/workflow_id")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

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

HttpResponse<String> response = Unirest.get("https://api.markup.ai/agents/workflows/workflow_id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.markup.ai/agents/workflows/workflow_id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.markup.ai/agents/workflows/workflow_id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/agents/workflows/workflow_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```