Quickstart

このページは、公開 API が利用可能になったときの基本フローを示す schema preview です。 現在は API key を発行しておらず、次の request はまだ実行できません。

1. ContentSpace を作成する

ContentSpace は、関連する Asset をまとめる最上位の公開 resource です。create / submit 系 request には 一意な Idempotency-Key を付けます。

curl --request POST "${NAKATAKU_ENGINE_API_BASE_URL}/content-spaces" \
  --header "X-Api-Key: ${NAKATAKU_ENGINE_API_KEY}" \
  --header "Idempotency-Key: ${IDEMPOTENCY_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"displayName":"Product archive"}'

実際の field 名と response は API Reference を正としてください。

2. Asset upload を登録する

小さな媒体は direct upload、大きな媒体は multipart upload を選びます。媒体本体を API Gateway の request body へ含めず、発行された upload URL へ送信します。

3. upload を確定する

upload 後に confirm または multipart complete を呼びます。検証が非同期の場合は 202 Accepted と Run が返り、Location の resource を poll できます。

4. indexing を開始する

Asset の indexing を submit し、Run と Asset の index status を確認します。すべての current Asset が 同じ generation へ投影されるまで、検索用の active route は公開されません。

5. 検索へ進む

ContentSpace の active route が公開された後、Direct Search で1回のretrievalを実行します。 次のrequestは契約確認用であり、availability が schema-only の間は実行できません。

curl --request POST "${NAKATAKU_ENGINE_API_BASE_URL}/search" \
  --header "X-Api-Key: ${NAKATAKU_ENGINE_API_KEY}" \
  --header "Idempotency-Key: ${IDEMPOTENCY_KEY}" \
  --header "Content-Type: application/json" \
  --data '{"contentSpaceId":"space_...","queryText":"夕暮れの海岸","maxResults":10}'

結果は最大10件の根拠付きMomentです。該当なしは results: [] の成功responseであり、検索可能な active routeがなければ部分結果を返さず 409 precondition_failed になります。Agentic Search は Public Beta 1 の公開対象ではありません。