Skip to main content
GET
/
v1alpha1
/
public
/
knowledge-base
/
document
Search documents
curl --request GET \
  --url https://realtime-api.voiceflow.com/v1alpha1/public/knowledge-base/document \
  --header 'authorization: <api-key>'
{
  "total": 123,
  "data": [
    {
      "documentID": "<string>",
      "data": {
        "type": "csv",
        "name": "<string>",
        "rowsCount": 123
      },
      "updatedAt": "2023-11-07T05:31:56Z",
      "status": {
        "type": "ERROR",
        "data": "<unknown>"
      }
    }
  ]
}

Authorizations

​
authorization
string
header
required

Voiceflow Dialog Manager API key (VF.DM) or Workspace API key (VF.WS)

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

Response

200 - application/json

Documents matching the specified criteria.

​
total
number
required
​
data
object[]
required