curl --request PATCH \
--url https://realtime-api.voiceflow.com/v1alpha1/public/knowledge-base/document/{documentID} \
--header 'Content-Type: knowledgeBase' \
--header 'authorization: <api-key>' \
--data '
{
"data": {
"documentMetadata": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"metadata": {},
"projectEnvironmentIDOrAlias": "<string>"
}
}
'{
"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>"
}
}
}Update the metadata associated with the specified document.
documentMetadata field can be used in agent KB metadata filter conditions. The metadata field is chunk-level and cannot be used for agent-level filtering. Learn more about metadata filtering.curl --request PATCH \
--url https://realtime-api.voiceflow.com/v1alpha1/public/knowledge-base/document/{documentID} \
--header 'Content-Type: knowledgeBase' \
--header 'authorization: <api-key>' \
--data '
{
"data": {
"documentMetadata": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"metadata": {},
"projectEnvironmentIDOrAlias": "<string>"
}
}
'{
"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>"
}
}
}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.
Hide child attributes
An array of document metadata fields.
💡 Tip: This metadata can be used in agent KB metadata filter conditions. Learn more about metadata filtering.
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 updated successfully.
Hide child attributes
Hide child attributes
url daily, weekly, monthly, never zendesk, shopify Was this page helpful?