Edit Document By ID

PUT

/api/document/{document_id}

This endpoint allows authenticated users to update the details of a specific document using its ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/document/0' \
--header 'Ocp-Apim-Subscription-Key: {{your-api-key}}' \
--header 'Authorization: Bearer {{your-access-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": {
        "id": 4,
        "email": "user@example.com"
    },
    "modified_by": "user@example.com",
    "type": "file",
    "source": "Updated_Document.txt",
    "tags": [
        "string"
    ],
    "is_deleted": false,
    "upload_from": "web",
    "step": "completed",
    "is_failed": false,
    "corpus": 484
}'

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 By ID

Delete Document By ID