Skip to main content
PUT
/
documents
/
{id}
Update Document
curl --request PUT \
  --url https://api.example.com/documents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "title": "<string>",
  "url": "<string>",
  "documentId": "<string>"
}
'
{
  "success": true
}

Path Parameters

id
string
required
The ID of the document to update.

Body

text
string
required
The updated raw text content of the document.
title
string
An updated title for the document.
url
string
An updated URL specifying where the document originated.
documentId
string
The underlying document ID, usually kept the same.

Response

success
boolean
Indicates whether the update was successful.
Example Request
{
  "title": "Welcome Updated",
  "text": "Hello world. This is an updated test document."
}
Example Response
{
  "success": true
}