Skip to main content
PUT
/
v1
/
knowledge
/
documents
/
{id}
update knowledge document
curl --request PUT \
  --url https://api.anam.ai/v1/knowledge/documents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "updated-filename.pdf"
}
'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "knowledgeFolderId": "00000000-0000-0000-0000-000000000000",
  "filename": "getting-started.pdf",
  "fileType": "application/pdf",
  "fileSize": 248320,
  "fileUrl": "https://cdn.anam.ai/knowledge/getting-started.pdf",
  "status": "READY",
  "errorMessage": null,
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": "2026-04-20T10:01:12.000Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier of the knowledge document

Body

application/json

Rename the document. Only filename is editable; the stored file and its extracted chunks are unchanged.

filename
string

New filename for the document

Response

Successfully updated document

A single file uploaded into a knowledge group. Retrieved chunks reference it by ID.

id
string<uuid>

Unique identifier for the document.

knowledgeFolderId
string<uuid>

ID of the knowledge group this document belongs to.

filename
string

Original filename as uploaded.

fileType
string

MIME type or extension-derived file type.

fileSize
integer

Size of the file in bytes.

fileUrl
string<uri>

Internal URL at which the file is stored.

status
enum<string>

Current processing state. Only READY documents are searchable.

Available options:
UPLOADED,
PROCESSING,
READY,
FAILED
errorMessage
string | null

Failure reason when status is FAILED, otherwise null.

createdAt
string<date-time>

Timestamp when the document was uploaded.

updatedAt
string<date-time> | null

Timestamp when the document record was last updated.

Last modified on April 22, 2026