Search documents - Voiceflow Documentation

Authorizations

authorization

string

header

required

Voiceflow API key

Query Parameters

page

string

The page number to retrieve, defaults to 1 (which is the minimum). Order is by the date updated, descending.

limit

string

The number of documents to return per page. Defaults to 10, range is 1-100.

documentType

enum<string>

Filters the document list by type (url, pdf, text, docx). Defaults to all document types.

Available options:

csv,

pdf,

text,

url,

docx,

table,

xlsx,

md

projectEnvironmentIDOrAlias

string

The alias of the environment to target (ie. main). You can find this in the environments page of your agent.

💡 Tip: Learn more about Environments.

Response

200 - application/json

Documents matching the specified criteria.

total

number

required

data

object[]

required

Hide child attributes

data.documentID

string

required

data.data

object

required

Hide child attributes

data.data.type

enum<string>

required

Available options:

url

data.data.name

string

required

data.data.url

string

required

data.data.refreshRate

enum<string>

Available options:

daily,

weekly,

monthly,

never

data.data.lastSuccessUpdate

string

data.data.accessTokenID

number

data.data.integrationExternalID

string

data.data.source

enum<string>

Available options:

zendesk,

shopify

data.updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

data.status

object

required

Hide child attributes

data.status.type

enum<string>

required

Available options:

ERROR,

PENDING,

SUCCESS,

INITIALIZED

data.status.data

any