Endpoint Compliance Check

INFO

See Getting Started with AI Features for setup requirements.

Overview

You can use AI to perform an endpoint compliance check on your current API documentation based on the API design guidelines. The AI will generate a comprehensive report to help you improve your API documentation so it aligns better with design standards — making it more professional, consistent, and easy to read.

What the Compliance Check Evaluates

The AI analyzes your endpoint against multiple criteria:

Criteria	Description
Naming Conventions	Checks if endpoint paths, parameters, and fields follow standard naming patterns
Documentation Completeness	Verifies that descriptions, examples, and constraints are provided
HTTP Method Usage	Ensures proper use of GET, POST, PUT, DELETE, etc.
Response Structure	Validates response format and error handling
Security Practices	Reviews authentication and authorization requirements

Using Endpoint Compliance Check

You can access the endpoint compliance check feature from the upper-right corner of any API documentation page. Simply click it to begin the AI-driven endpoint compliance check.

After clicking the Endpoint compliance check button, the AI will analyze the API documentation based on the API design guidelines. It will then provide a score for each evaluation criteria, along with detailed explanations and suggestions for improvement.

Endpoint Compliance Check

Overview#

What the Compliance Check Evaluates#

Using Endpoint Compliance Check#

Overview

What the Compliance Check Evaluates

Using Endpoint Compliance Check