Documents

外部 ID で文書を作成・更新する

external_id は encodeURIComponent で符号化してパスに入れる（faq/shipping は faq%2Fshipping）。If-Match は任意で、指定すると head の版が違えば 412 になる

put/knowledge/sources/{source_id}/documents/{external_id}

Request

  • Base URL: https://api.leafchat.app/api/v1
  • URL: https://api.leafchat.app/api/v1/knowledge/sources/{source_id}/documents/{external_id}
  • Auth: HTTP bearer

Path parameters

source_idstring required
Example:k9x2m4q7w1e5r8t3y6u0i2o4
external_idstring required

外部 ID は、ソースの中で一意の文字列です。UTF-8 で 512 バイトまで、Unicode の NFC にそろえ、/ で区切れます。空の区切り・.・..・区切りの前後の空白・制御文字・\ は使えません。例：faq/shipping、渋谷店/営業時間.md

Example:faq%2Fshipping

encodeURIComponent で符号化して送る（faq/shipping は faq%2Fshipping）。サーバーは復号した値を検査する

Headers

if-matchstring
Example:"r7t2y5u8i1o4p6a9s3d0f2g5"

GET で受け取った ETag（"<版の ID>"）。強い比較の 1 つの値だけを受ける

Request body

filenamestring required
contentstring required
content_type'text/markdown' | 'text/plain' | 'application/json' required

Response

内容が同じで、何も変えなかった

document_idstring required
revision_idstring required
outcome'created' | 'updated' | 'unchanged' required

Changes

No recorded changes to this operation across all 1 revision of this API.