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

Authorizations

authorization
string
header
required

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

Path Parameters

documentID
string
required

ID of the document to target.

Response

200 - application/json

The target document was found.

data
object
required
chunks
object[]
metadata
object[]