ナレッジストアをAPIで操作する

ナレッジストアへの文書の追加、更新をAPIで行うことができます。

ナレッジストアのAPIキーの発行

ナレッジストアをAPIで操作するには、事前にAPIキーの発行が必要です。
ナレッジストア画面に「APIキー再発行」ボタンがあるので、クリックすると発行されます。
APIキーは、ナレッジストア画面に表示されます。

文書一覧の取得

ナレッジストアの文書一覧を取得できます。

curl --request GET \
  --url https://api.gen2go.com/knowledge_stores/{ナレッジストア識別子} \
  --header 'x-api-key: {ナレッジストアのAPIキー}'

レスポンス例

{
  "identifier": "{ナレッジストア識別子}",
  "name": "APIテスト",
  "status": "ENABLED",
  "created_at": "2025-12-27T06:46:18.427559+00:00",
  "modified_at": "2025-12-27T12:46:53.911179+00:00",
  "description": "",
  "documents": [
    {
      "identifier": "{文書識別子}",
      "status": "SUCCESS",
      "source_type": "IMAGE_DOC",
      "job_id": "{ジョブID}"
    },

文書の追加

テキスト、CSVファイル、PDF / オフィスファイル、PDF（画像認識）を追加できます。

文書タイプ	source_typeの値	MIMEタイプの例	備考
テキスト	TEXT	不要	text=の後にテキストをセットします。
CSV	CSV	text/csv	ファイルをアップロードします。
PDF / オフィスファイル	FILE	application/pdf など	ファイルをアップロードします。
PDF（画像認識）	IMAGE_DOC	application/pdf	ファイルをアップロードします。

テキストの場合

curl --request POST \
  --url https://api.gen2go.com/knowledge_stores/{ナレッジストア識別子}/documents \
  --header 'x-api-key: {ナレッジストアのAPIキー}' \
  --form 'source_type=TEXT' \
  --form 'text=サンプルのテキストです。'

ファイルの場合（CSV / FILE / IMAGE_DOC）

curl --request POST \
  --url https://api.gen2go.com/knowledge_stores/{ナレッジストア識別子}/documents \
  --header 'x-api-key: {ナレッジストアのAPIキー}' \
  --form 'source_type=CSV' \
  --form 'file=@{ファイルパス};type={MIMEタイプ}'

レスポンス例

{
  "document_identifier": "{文書識別子}",
  "job_id": "{ジョブID}",
  "status": "PENDING"
}

文書の更新

パスに文書識別子を加えることと、HTTPメソッドがPUTとなること以外は、文書の追加時と同様です。

curl --request PUT \
  --url https://api.gen2go.com/knowledge_stores/{ナレッジストア識別子}/documents/{文書識別子} \
  --header 'x-api-key: {ナレッジストアのAPIキー}' \
  --form 'source_type=TEXT' \
  --form 'text=サンプルのテキストです。'

文書の削除

curl --request DELETE \
  --url http://localhost:8080/knowledge_stores/{ナレッジストア識別子}/documents/{文書識別子} \
  --header 'x-api-key: {ナレッジストアのAPIキー}'

APIドキュメント

詳細は、Gen2Go APIドキュメントをご確認ください。