Edit Document

PUT

/v2/api/document/{document_id}

Allows authenticated users to update the content of an existing document by specifying its unique document_id. This endpoint is ideal for modifying or correcting the extracted text of a document post-upload.

Purpose:

To provide users the ability to revise the document’s textual content.

Ensures that document data remains accurate, up-to-date, and reflective of any necessary changes.

What is document_id?

document_id is a unique numeric identifier assigned to each document in the system.

It acts as a reference to locate and apply updates specifically to that document without confusion.

How to View Your Document ID?

To find your Document ID, visit the View Document ID Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///v2/api/document/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "I am user"
}'

Response Example

{
    "document_id": 13212,
    "message": "Document updated successfully."
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Document updated successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Get Document

Add Or Remove Tags On Document

Edit Document

How to View Your Document ID?#

Request

Responses

How to View Your Document ID?