curl --request GET \
--url https://realtime-api.voiceflow.com/v1alpha1/public/knowledge-base/document/{documentID} \
--header 'authorization: <api-key>'{
"data": {
"documentID": "<string>",
"data": {
"type": "url",
"name": "<string>",
"url": "<string>",
"refreshRate": "daily",
"lastSuccessUpdate": "<string>",
"accessTokenID": 123,
"integrationExternalID": "<string>",
"source": "zendesk"
},
"updatedAt": "2023-11-07T05:31:56Z",
"status": {
"type": "ERROR",
"data": "<unknown>"
}
},
"chunks": [
{
"chunkID": "<string>",
"content": "<string>",
"metadata": {}
}
],
"metadata": [
{
"key": "<string>",
"values": [
"<string>"
]
}
]
}Fetch all chunks and metadata for the specified 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": "url",
"name": "<string>",
"url": "<string>",
"refreshRate": "daily",
"lastSuccessUpdate": "<string>",
"accessTokenID": 123,
"integrationExternalID": "<string>",
"source": "zendesk"
},
"updatedAt": "2023-11-07T05:31:56Z",
"status": {
"type": "ERROR",
"data": "<unknown>"
}
},
"chunks": [
{
"chunkID": "<string>",
"content": "<string>",
"metadata": {}
}
],
"metadata": [
{
"key": "<string>",
"values": [
"<string>"
]
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.voiceflow.com/llms.txt
Use this file to discover all available pages before exploring further.
Voiceflow API key
ID of the document to target.
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.
The target document was found.
Hide child attributes
Hide child attributes
url daily, weekly, monthly, never zendesk, shopify Was this page helpful?