Read playbook instructions
GET
Read playbook instructions

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

playbookID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

offset
integer
default:1

The 1-based line number to start from. Clamped to the last line of the document.

limit
integer
default:400

The maximum number of lines to return. A page is also capped at 24,000 characters, so a page of very long lines can come back shorter than this — follow nextOffset while hasMore is true.

Response

200 - application/json

Returns the requested lines of the playbook's instructions as one numbered block, with the page's actual offset, its line count, the document's total lines and characters, and whether more lines follow.

content
string
required

The requested lines, each as its 1-based number, a tab, then the text, joined by newlines.

offset
integer
required

The line number this page actually starts at, after clamping.

returnedLines
integer
required

How many lines this page carries.

totalLines
integer
required

How many lines the whole document has.

totalCharacters
integer
required

How many characters the whole document has.

hasMore
boolean
required

Whether lines remain after this page.

nextOffset
integer
required

The first line not returned, or null when there is nothing more to read.

Voiceflow Documentation

    Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.