Playbooks

Start a playbook run

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.

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

Path parameters

idstring uuid required

Playbook ID

Request body

topicstring

Topic to seed the run, when the playbook generates new content.

content_idstring uuid

Existing content the run should operate on.

site_idstring uuid

Site the run is scoped to, when required by the playbook.

Response

Run started

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.