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

# Create an agent run

POST https://api.middesk.com/v1/runs
Content-Type: application/json

Creates a new agent run

Reference: https://docs.middesk.com/api-reference/agents/runs/create-agent-run

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `type` (string, required) — The agent type to use for this agent run
- `business_id` (string, optional) — Business to use as context for the run. Shorthand for context_type=business. Required when thread_id is not provided (unless context_type and context_id are given).
- `context_type` (string, optional) — The type of context resource (e.g., "business")
- `context_id` (string, optional) — The ID of the context resource. Must be provided with context_type.
- `thread_id` (string, optional) — Optional agent thread ID in which to execute the agent run

## Response

### 201

agent run created within existing agent thread

- `object` (string, required) — Object type identifier.
- `id` (string, required) — Unique identifier for the agent run.
- `created_at` (datetime, required) — Timestamp when the agent run record was created.
- `updated_at` (datetime, required) — Timestamp when the agent run record was last updated.
- `status` (enum, required) — Current lifecycle status of the agent run.
  - Allowed values: `running`, `completed`, `error`, `interrupted`
- `thread_id` (string, optional) — Identifier of the agent thread this run belongs to.
- `business_id` (string, optional, nullable) — Middesk business the run is scoped to. Null when the run was started with an inline `business` payload whose business did not exist yet.
- `agent` (string, optional) — Agent type that produced this run (for example, `cip_orchestrator`).
- `requester` (AgentsRunRequester, optional, nullable) — Principal that initiated the run. Populated with the authenticated user's identity when a session caller initiates the run, and with the account when an API key caller initiates the run. `null` for system-initiated runs.
- `started_at` (datetime, optional, nullable) — Timestamp when the agent run started.
- `ended_at` (datetime, optional, nullable) — Timestamp when the agent run finished.
- `output` (AgentsRunOutput, optional, nullable) — Artifact envelope produced by the agent. Non-null only when `status` is `completed`; `null` for `running`, `interrupted`, and `error` runs.
- `interrupts` (list of AgentsRunInterruptsItem, optional) — Pending interrupt requests awaiting input. Empty when the run is not interrupted. To resume a run, POST the interrupt's `id` along with the caller-supplied input to `POST /v1/runs/{id}/resume`.
- `steps` (list of AgentsStep, optional) — Top-level execution steps for this run. Opt-in: pass `?include=steps` on `GET /v1/runs/{id}` (or `POST /v1/runs/{id}/resume`) to populate this field. Omitted by default to avoid the cost of fetching step state from the underlying execution backend.

## Errors

### 400 Create Agent Run Request Bad Request Error

missing context when thread_id is not provided

- `errors` (list of ErrorResponseErrorsItem, required)

### 404 Create Agent Run Request Not Found Error

agent thread not found

- `errors` (list of ErrorResponseErrorsItem, required)

### 422 Create Agent Run Request Unprocessable Entity Error

inline business payload refers to business in audit

- `errors` (list of ErrorResponseErrorsItem, required)

## Types

### AgentsRunRequester

Principal that initiated the run. Populated with the authenticated user's identity when a session caller initiates the run, and with the account when an API key caller initiates the run. `null` for system-initiated runs.

- `id` (string, required) — Identifier of the requesting user or account.
- `name` (string, required) — Display name of the requester.
- `email` (string, optional, nullable) — Email address of the requester. Populated for user requesters and `null` for account requesters.

### AgentsRunOutput

Artifact envelope produced by the agent. Non-null only when `status` is `completed`; `null` for `running`, `interrupted`, and `error` runs.

- `artifacts` (list of AgentsArtifact, required) — Artifacts produced by the agent during this run.

### AgentsRunInterruptsItem

- `id` (string, required) — Identifier of the interrupt request.
- `value` (map from string to any, required) — Agent-defined interrupt payload. Shape varies by agent, but typically carries `agent` (the sub-agent that raised the interrupt), `label` (human-readable prompt), and `artifacts` (proposed changes awaiting review). The orchestrator agent (`cip_orchestrator`) wraps sub-agent interrupts under a `proposals` array with `type: combined_proposal`.
- `agent` (string, optional, nullable) — Agent type that raised the interrupt. Lifted from `value.agent` and surfaced at the top level for convenience; omitted when the interrupt did not declare an agent.

### AgentsStep

A step in an agent workflow execution timeline.

- `id` (string, required) — Unique identifier for the step.
- `run_id` (string, required) — Identifier of the agent run that produced the step.
- `type` (enum, required) — Category of step output.
  - Allowed values: `activity`, `output`, `interrupt`, `error`
- `name` (string, required) — Internal step name.
- `label` (string, required) — Human-readable step label.
- `status` (enum, required) — Current execution status for the step.
  - Allowed values: `running`, `completed`, `error`
- `started_at` (datetime, required) — Timestamp when the step started.
- `agent` (string, optional) — Agent identifier that generated this step.
- `parent_step_id` (string, optional, nullable) — Parent step identifier for nested steps.
- `completed_at` (datetime, optional, nullable) — Timestamp when the step completed.
- `steps` (list of AgentsStep, optional) — Nested child steps.
- `result` (AgentsStepResult, optional) — Structured result payload for the step.
- `artifacts` (list of AgentsArtifact, optional) — Artifacts produced by the step.

### ErrorResponseErrorsItem

- `message` (string, required)
- `parameter` (string, optional) — Request parameter associated with the error, when applicable

### AgentsArtifact

A structured artifact produced by an agent step.

- `title` (string, required) — Human-readable title for the artifact.
- `type` (string, required) — Artifact type identifier.
- `confidence` (string, optional, nullable) — Optional confidence label for artifact quality.
- `summary` (string, optional, nullable) — Optional summary of the artifact contents.
- `sources` (list of AgentsSource, optional) — Source references used to produce the artifact.

### AgentsStepResult

Structured result payload for the step.

- `resolution` (enum, optional) — How the interrupt was resolved. Present only on completed interrupt steps when an interrupt policy auto-approved or skipped the interrupt. Absent for manual resolutions.
  - Allowed values: `auto_approve`, `skip`

### AgentsSource

A source reference used by an agent artifact.

- `url` (string, required) — Canonical source URL.
- `source_name` (string, optional) — Human-readable source name.
- `source_tier` (string, optional) — Source quality or trust tier.
- `source_type` (string, optional) — Source category.

## Examples

**Request**

```json
{
  "type": "cip_orchestrator"
}
```

**Response**

```json
{
  "object": "run",
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "running",
  "thread_id": "thread_id",
  "business_id": "business_id",
  "agent": "agent",
  "requester": {
    "id": "id",
    "name": "name",
    "email": "email"
  },
  "started_at": "2024-01-15T09:30:00Z",
  "ended_at": "2024-01-15T09:30:00Z",
  "output": {
    "artifacts": [
      {
        "title": "title",
        "type": "type"
      }
    ]
  },
  "interrupts": [
    {
      "id": "id",
      "value": {
        "key": "value"
      },
      "agent": "agent"
    }
  ],
  "steps": [
    {
      "id": "id",
      "run_id": "run_id",
      "type": "activity",
      "name": "name",
      "label": "label",
      "status": "running",
      "started_at": "2024-01-15T09:30:00Z",
      "agent": "agent",
      "parent_step_id": "parent_step_id",
      "completed_at": "2024-01-15T09:30:00Z",
      "artifacts": [
        {
          "title": "title",
          "type": "type"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.middesk.com/v1/runs"

payload = { "type": "cip_orchestrator" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.middesk.com/v1/runs';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"type":"cip_orchestrator"}'
};

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

```go
package main

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

func main() {

	url := "https://api.middesk.com/v1/runs"

	payload := strings.NewReader("{\n  \"type\": \"cip_orchestrator\"\n}")

	req, _ := http.NewRequest("POST", 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.middesk.com/v1/runs")

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

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

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.post("https://api.middesk.com/v1/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"cip_orchestrator\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.middesk.com/v1/runs', [
  'body' => '{
  "type": "cip_orchestrator"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.middesk.com/v1/runs");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"type\": \"cip_orchestrator\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.middesk.com/v1/runs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```