ドキュメント本文へスキップ
API

ファイルをアップロードする

リクエスト本文として送り、バックグラウンドで読み取る文書または画像。

POST/knowledge/files

実際の呼び出しをワークスペースに対して実行します。

POST /knowledge/files

リクエスト本文として送り、バックグラウンドで読み取る文書または画像。

例

knowledge:write が必要。ファイルそのものを Content-Type とともに本文として送り、filename または X-Filename ヘッダーで名前を付ける。scope と title もクエリに入れる。文書は最大 20 MB、画像は最大 10 MB。queued のファイルとともに 201 を返す。

curl
curl -X POST "$OE/knowledge/files?filename=price-list.pdf&[email protected]" -H "$AUTH" \  -H "Content-Type: application/pdf" --data-binary @price-list.pdf
レスポンス
{  "object": "knowledge_item",  "id": "kb_9a4d2c7e1b5f3086d2e4a19c",  "kind": "file",  "scope": "[email protected]",  "level": "address",  "title": "price-list",  "url": null,  "fileName": "price-list.pdf",  "mimeType": "application/pdf",  "sizeBytes": 482113,  "pinned": false,  "status": "queued",  "failure": null,  "chunks": 0,  "chars": 0,  "origin": "api",  "createdBy": "usr_5f2a9c71",  "createdAt": "2026-10-08T09:15:30.000Z",  "updatedAt": "2026-10-08T09:15:30.000Z",  "indexedAt": null}

Content-Type が汎用的なときは、名前の拡張子でファイルの種類を判断する。読み取れない種類のファイルは 422 knowledge_file_unsupported、空のファイルは 422 knowledge_file_empty、上限を超えるファイルは 413 knowledge_file_too_large。

テキストを含まないファイルは failure: "empty" 付きの failed で終わる。同じファイルを 2 回送ると 2 回保存される。

リファレンス