Search playbook instructions
POST
Search 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).

Body

pattern
string
required

A JavaScript regular expression, evaluated against each line on its own.

ignoreCase
boolean
default:false

Match case-insensitively. Defaults to false, like grep.

contextLines
integer
default:0

How many lines either side of each match to return.

limit
integer
default:50

The maximum number of matching LINES to return. The reported totals cover the whole document.

Response

200 - application/json

Returns the matching lines of the playbook's instructions, each with its line number, hit count and context lines, plus the total matches and matching lines across the whole document and whether the limit cut the list short.

matches
object[]
required
totalMatches
integer
required

Total occurrences across the whole document, not just this page.

matchingLines
integer
required

Total lines with at least one occurrence, across the whole document.

hasMore
boolean
required

Whether matching lines were left out because of the limit.

Voiceflow Documentation

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