---
title: "文書の一覧"
method: GET
path: "/knowledge/documents"
tags: ["Documents"]
---

# 文書の一覧

`GET /knowledge/documents`

## Request

- Base URL: `https://api.leafchat.app/api/v1`
- URL: `https://api.leafchat.app/api/v1/knowledge/documents`
- Auth: HTTP bearer

作成の新しい順。next_cursor が null でなければ、cursor に入れて次のページを取る

## Query parameters

- `source_id` string
- `folder_id` string
- `external_id` string: source_id と一緒のときだけ指定できる
- `status` 'processing' | 'pending' | 'ready' | 'error'
- `cursor` string: 前の応答の next_cursor
- `limit` integer

## Response `200`

文書の 1 ページ

- object
  - `documents` Document[], required
    - `id` string, required
    - `source_id` string, required
    - `external_id` string, nullable, required
    - `folder_id` string, nullable, required: null はフォルダに割り当てる前に登録した文書。サイト別の出し分けを有効にすると既定のフォルダに入る
    - `filename` string, required
    - `mime` string, nullable, required
    - `size` integer, nullable, required
    - `status` 'processing' | 'pending' | 'ready' | 'error', required
    - `current_revision` RevisionRef, required
      - `id` string, required
      - `number` integer, required
      - `state` 'queued' | 'processing' | 'indexing' | 'live' | 'failed' | 'superseded' | 'abandoned', required
      - `error_message` string, nullable, required
      - `created_at` string, date-time, required
    - `head_revision` RevisionRef, required
      - `id` string, required
      - `number` integer, required
      - `state` 'queued' | 'processing' | 'indexing' | 'live' | 'failed' | 'superseded' | 'abandoned', required
      - `error_message` string, nullable, required
      - `created_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required: 内容の更新日時。公開中の版（無ければ head_revision）の内容を受け付けた時刻。フォルダの移動・状態の変化・システムの取り込み直しでは変わらない
  - `next_cursor` string, nullable, required

## Other responses

- `400`: 要求の形式か値が正しくない。errors（検証の誤り）に項目（path）ごとの理由が入る 返る code：`invalid_request`・`empty_manifest`・`duplicate_item`
- `401`: API キーが無いか無効（期限切れ・失効・削除の途中の組織を含み、理由は区別しない） 返る code：`unauthorized`
- `403`: この API キーの用途か、対象のソースでは実行できない 返る code：`forbidden`・`needs_draft`
- `429`: 上限を超えた。Retry-After の秒数だけ待ってからやり直す。上限は、API キーごとに 1 分 120 回（REST と MCP で共通）・同期の実行は鍵ごとに 1 分 10 回（dry_run は数えない）・組織の文書の書き込みは 1 分 300 版・API キーの検証の失敗は IP ごとに 1 分 20 回（超えると、正しい鍵でも 429 になる）。このほか、IP ごとの上限を超えると Cloudflare が 429（error code 1015）を返す。この応答は problem+json でないことがあり、Retry-After が無ければ少し待ってからやり直す 返る code：`rate_limited`
- `500`: サーバーで問題が起きた。少し待ってからやり直す 返る code：`internal_error`

---

[API](https://skmtc.dev/leafchat/apis/leafchat-api.md) · [All operations](https://skmtc.dev/leafchat/apis/leafchat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/leafchat/apis/leafchat-api/revisions/2667db05c2ff?raw)