List document folders

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/document-folder \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/document-folder?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/document-folder?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "folders": [
    {
      "id": "<string>",
      "name": "<string>",
      "parentID": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

List document folders

Returns every folder that organizes the knowledge base’s documents in one response; `parentID` nests a folder inside another and is null at the top level. Use a folder’s `id` as `folderID` to file a document under it.

GET

/v1/stable/document-folder

curl --request GET \
  --url https://realtime-api.voiceflow.com/v1/stable/document-folder \
  --header 'Authorization: Bearer <token>'

const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/document-folder?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();

import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/document-folder?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()

{
  "folders": [
    {
      "id": "<string>",
      "name": "<string>",
      "parentID": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

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).

Response

200 - application/json

Returns every knowledge base folder in the environment, each with its ID, name, parent folder ID, and timestamps.

folders

object[]

required

Show child attributes

string

required

name

string

required

The name of the folder.

parentID

string

required

The ID of the folder this folder is nested in, or null for a top-level folder.

createdAt

string

required

updatedAt

string

required

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

List document folders

Authorizations

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks