Delete document folder

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

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

import requests

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

{
  "message": "<string>"
}

Delete document folder

Deletes a knowledge base folder together with its subfolders and every document inside them. The response carries only a confirmation message, so refetch the folders and documents to see what is left.

DELETE

/v1/stable/document-folder/{folderID}

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

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

import requests

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

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Path Parameters

folderID

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

Response

200 - application/json

Confirms the folder was deleted. The body is a message only, so refetch the folder list to see it gone.

message

string

required

A human-readable message confirming the deletion.

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks

Delete document folder

Authorizations

Path Parameters

Query Parameters

Response

Getting started

Running agents

Build

Manage

Publishing

Observe

Insights

QA

Analytics

Webhooks