NAKATAKU ENGINE Docsv1.0https://stg.api.engine.nakataku.ai/v1.0Consoleへ戻る
ドキュメントメニュー

Resources

OpenAPI

公開 OpenAPI JSON をダウンロードできます。Swagger 2.0 documentで、 proto/nakataku/engine/v1/public_lifecycle.proto から生成されています。

Public Beta 1 の候補は ContentSpaces、Assets、Indexing、Runs、Direct Search です。公開 artifact には 生成時点の契約だけを含め、Console 専用BFF、MCP、内部 gRPC service、ADR、運用手順は含めません。

Version

初期 REST base path は /v1.0、OpenAPI info.version1.0、proto package は nakataku.engine.v1 です。公開後の additive な契約変更は REST minor version を上げ、既存 minor と 並走します。

Availability

x-nakataku-availabilityschema-only の operation は schema preview であり、一般提供されて いません。利用可能性は Docs の文章ではなく、生成された OpenAPI extension と一致させます。

更新方針

  • 公開 contract の変更は proto を更新して OpenAPI を再生成します。
  • 説明や example の訂正だけでは API version を上げません。
  • 未提供 SDK の言語 tab や、存在しない endpoint の例は掲載しません。