Skip to main content

OpenAPI contracts

Use these pages when you need the exact request and response contract for a specific product surface, not when you are still deciding which endpoint pattern fits the workflow.

The API guide explains when to use ad-hoc evaluation, saved-mapping execution, route-aware subroutes, and operational endpoints. The OpenAPI pages take over once you need precise parameters, payload schemas, and response details.

Choose the product contract

ProductBest use
CommunityReview the Community contract when you need exact operation, parameter, and schema details.
EnterpriseReview the Enterprise contract when you need exact operation, parameter, and schema details for Enterprise deployments.

Community OpenAPI

Open the Community contract page when you need the exact request and response contract for Community server deployments.

Enterprise OpenAPI

Open the Enterprise contract page when you need the exact request and response contract for Enterprise server deployments.