API リファレンス

共通の約束

• 読み取り専用: すべて GET です。状態を変える操作はありません。
• ページサイズ: limit の既定値は 60、上限は 200 です。
• カーソル: 応答の next_cursor を次の cursor に渡します。最後のページでは null です。
• 検証エラー: 値が不正なときは 422 と invalid_query を返し、項目ごとの説明を error.fields に入れます。
• 対象なし: 公開投影に存在しない ID は 404 と not_found です。
• 書き込み: GET 以外は 405 と method_not_allowed です。
• キャッシュ: 匿名向けの応答だけを共有キャッシュに載せます。アカウント情報は含みません。
• 機械可読スキーマ: /api/schema.json（OpenAPI 3.1）

エンドポイント

一覧の形

{
  "items": [ … ],
  "next_cursor": 12345,
  "facets": { … }        // 最初のページだけ
}

一覧は facets を最初のページにだけ含みます。2 ページ目以降は items と next_cursor だけです。

エラーの形

{
  "error": {
    "code": "invalid_query",
    "message": "クエリの値を確認してください。",
    "fields": { "limit": "1〜200 の整数で指定してください。" }
  }
}

返さない項目

• 内部の観測 ID、原 payload、payload のハッシュ、外部キー。
• producer ID、アカウント、メールアドレス、session。
• 非公開音声の配信キーと、downloads.read が必要な配布ファイル。
• 公開台帳で非公開とされた項目、および台帳に規則がない項目。

非公開音声は media.listen、配布ファイルは downloads.read を持つログイン済みの利用者だけが、それぞれ専用の経路から取得できます。API はどちらも返しません。

注意

• 旧 /api/archive および /api/v1 系の経路は提供しません。転送も行いません。
• ID はカタログの entity_id で、名前が変わっても安定です。
• 公開投影を再構築すると、同じ ID の内容が更新されることがあります。