はじめに

RAG 用データ API の概要と、全エンドポイントに共通する約束事。

RAG (Retrieval-Augmented Generation) 向けのデータ検索 API の仕様を掲載しています。検索クエリと絞り込み条件を受け取り、関連するチャンクを関連度順に返します。

ベータ版について

RAG 用データ API は現在ベータ版として提供しています。正式版ではエンドポイント、リクエスト/レスポンスの形式、制限事項などが変更される可能性があります。ベータ期間中は無料で利用できます。正式版の提供条件は別途ご案内します。

API の概要

クライアントは検索クエリを投げ、生成 AI へ渡すためのチャンク列を受け取ります。チャンクには関連度スコアと順位が付き、必要なフィールドだけを選んで受け取れます。

API	概要
RAG 用データ API	クエリと絞り込み条件から関連チャンクを関連度順に返す

リクエスト・レスポンスとも application/json です。エラーだけは RFC 9457 の application/problem+json で返します。詳細はエラーを参照してください。

日時は ISO 8601 (2026-01-31T09:00:00Z) で表します。

リクエスト・レスポンスの JSON キーには短縮名のみを使用します (q / flt / l / nq / r / rid など)。正式名は各エンドポイントのパラメータ説明に併記しています。

null になり得るのは、エンドポイントのスキーマで null 許容と示されたプロパティだけです。それ以外のプロパティは null を取りません。必須でないプロパティは省略できます。

レスポンスには原則として rid (response_id) が入ります。成功レスポンス、エラーレスポンスのいずれにも rid が入るため、問い合わせの際はこの値を添えてください。

トークンが無効・期限切れ・スコープ不足の場合、リクエストは API サーバに到達せずゲートウェイが 401 または 403 を返し、レスポンスに rid は入りません。発生条件と対処はエラーを参照してください。

このサイトのエンドポイントページは OpenAPI 定義 (api/openapi.yaml) からビルド時に組み立てています。サーバ実装の型とインターフェースも同じ 1 ファイルから生成しているため、掲載内容と実装が食い違うことはありません。

手で書いているのは、仕様に載せられない前提や運用上の約束事だけです。