---
title: "Start a playbook run"
method: POST
path: "/playbooks/{id}/runs"
tags: ["Playbooks"]
---

# Start a playbook run

`POST /playbooks/{id}/runs`

## Request

- Base URL: `https://next.frase.io/api/v1`
- URL: `https://next.frase.io/api/v1/playbooks/{id}/runs`
- Auth: API key in header `X-API-KEY`

Kick off a run of a playbook. Depending on the playbook's first step you may pass a `topic` (to generate from), an existing `content_id` (to operate on), and/or a `site_id`. A disabled playbook, an exhausted run quota, or too many concurrent runs are surfaced with specific error codes.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `topic` string: Topic to seed the run, when the playbook generates new content.
  - `content_id` string, uuid: Existing content the run should operate on.
  - `site_id` string, uuid: Site the run is scoped to, when required by the playbook.

## Response `201`

Run started

- object
  - `data` object
    - `id` string, uuid
    - `playbook_id` string, uuid
    - `status` 'pending' | 'running' | 'paused' | 'completed' | 'failed' | 'cancelled'
    - `topic` string, nullable
    - `current_step_index` integer, nullable
    - `current_step_name` string, nullable: The name this run stored for the current step position, resilient to later edits of the playbook definition.
    - `started_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable: Always null at start; populated when the run reaches a terminal state.
    - `paused_at` string, date-time, nullable: Always null at start; populated only when the run pauses.
    - `error` string, nullable: Always null at start; populated only on failure.
  - `request_id` string

## Other responses

- `400`: Validation failed
- `401`: Authentication failed
- `403`: Your subscription does not include this feature
- `404`: Resource not found
- `429`: Playbook run limit reached, or too many concurrent runs

---

[API](https://skmtc.dev/frase/apis/frase-api.md) · [All operations](https://skmtc.dev/frase/apis/frase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/frase/apis/frase-api/revisions/7fb75d89f7a4?raw)