Skip to main content
PUT
/
v1alpha1
/
public
/
knowledge-base
/
document
/
{documentID}
Replace document
curl --request PUT \
  --url https://realtime-api.voiceflow.com/v1alpha1/public/knowledge-base/document/{documentID} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "data": {
    "type": "url",
    "url": "<string>",
    "name": "<string>",
    "refreshRate": "daily",
    "folderID": "<string>",
    "metadata": {},
    "documentMetadata": [
      {
        "key": "<string>",
        "values": [
          "<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>"
    }
  }
}

Authorizations

​
authorization
string
header
required

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

Headers

​
content-type
string

Path Parameters

​
documentID
string
required

ID of the document to target.

Query Parameters

​
maxChunkSize
any

Determines how granularly each document is broken up. Range available is 500-1500 tokens, default is 1000. Smaller chunk size means narrower context, faster response, less tokens consumed, and greater risk of less accurate answers. Max chunk size affects the total amount of chunks parsed from a document - i.e., larger chunks means less chunks retrieved.

Body

​
data
object
required

Response

The target document was successfully replaced.

​
data
object
required