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"
}
'

import requests

url = "https://api.anam.ai/v1/knowledge/documents/{id}"

payload = { "filename": "updated-filename.pdf" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({filename: 'updated-filename.pdf'})
};

fetch('https://api.anam.ai/v1/knowledge/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/knowledge/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'filename' => 'updated-filename.pdf'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/knowledge/documents/{id}"

	payload := strings.NewReader("{\n  \"filename\": \"updated-filename.pdf\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.anam.ai/v1/knowledge/documents/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"updated-filename.pdf\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/knowledge/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filename\": \"updated-filename.pdf\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "chunkSize": null,
  "chunkOverlap": null,
  "appliedChunking": {
    "strategy": "paragraph",
    "chunkSize": 800,
    "chunkOverlap": 100,
    "source": "folder",
    "appliedAt": "2026-04-20T10:01:12.000Z"
  },
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": "2026-04-20T10:01:12.000Z"
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

PUT

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"
}
'

import requests

url = "https://api.anam.ai/v1/knowledge/documents/{id}"

payload = { "filename": "updated-filename.pdf" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({filename: 'updated-filename.pdf'})
};

fetch('https://api.anam.ai/v1/knowledge/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anam.ai/v1/knowledge/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'filename' => 'updated-filename.pdf'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anam.ai/v1/knowledge/documents/{id}"

	payload := strings.NewReader("{\n  \"filename\": \"updated-filename.pdf\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.anam.ai/v1/knowledge/documents/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"updated-filename.pdf\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anam.ai/v1/knowledge/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filename\": \"updated-filename.pdf\"\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "chunkSize": null,
  "chunkOverlap": null,
  "appliedChunking": {
    "strategy": "paragraph",
    "chunkSize": 800,
    "chunkOverlap": 100,
    "source": "folder",
    "appliedAt": "2026-04-20T10:01:12.000Z"
  },
  "createdAt": "2026-04-20T10:00:00.000Z",
  "updatedAt": "2026-04-20T10:01:12.000Z"
}

{
  "error": "Service temporarily unavailable",
  "message": "We could not check your API key. Please retry shortly."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Knowledge document ID, from GET /v1/knowledge/groups/{id}/documents

Body

application/json

Rename the document. Only filename is editable; the stored file and its extracted chunks are unchanged. Chunk settings can only be set at upload, so a non-null chunkSize or chunkOverlap returns 400.

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.

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.

chunkSize

integer | null

Chunk size override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkOverlap is set, a null chunkSize means the default of 350.

chunkOverlap

integer | null

Chunk overlap override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkSize is set, a null chunkOverlap means the default of 0.

appliedChunking

object | null

Settings the last successful processing used. Null until the document has been processed.

Show child attributes

createdAt

string<date-time>

Timestamp when the document was uploaded.

updatedAt

string<date-time> | null

Timestamp when the document record was last updated.

Use the API

Sessions

Meetings

Avatar Videos

Personas

Avatars

Voices

Pronunciation Dictionaries

LLMs

Knowledge

Tools

Share Links

Engine

update knowledge document

Authorizations

Path Parameters

Body

Response