> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API ENDPOINT TEMPLATE

# API endpoint page template

Use this checklist for every new or substantially changed endpoint page. Keep the OpenAPI panel authoritative for fields and place practical decision guidance in MDX.

```mdx theme={null}
---
title: "Verb Resource"
description: "Outcome-focused description in one sentence."
openapi: METHOD /v1/path
---

{/* Custom CSS mirrors this beside the generated endpoint heading. */}
<span data-api-safety-label="read-only"><Badge color="gray" size="sm" shape="pill">Read only</Badge></span>

Explain what the operation accomplishes and the resource lifecycle state it expects.

## Before you begin

- Required resource state, permissions, configuration, and IDs.
- Link to the operation that produces each prerequisite.

## Minimal request

Show the smallest valid body or query and explain where each placeholder comes from.

## Verify the result

State the status code, important response fields, follow-up GET, dashboard location, or webhook that proves success.

## Errors and recovery

List operation-specific errors, the likely cause, and the exact remediation. State whether retrying can duplicate work.

## Related endpoints

Link to the previous and next lifecycle operations.
```

## Review gates

* The example satisfies required fields, types, enums, and constraints.
* Request fields do not include keys absent from the public schema.
* Response prose and examples use the same envelope as OpenAPI.
* Side effects and retry safety are source-verified.
* Safety labels use a semantic `data-api-safety-label` wrapper, never a frontmatter `tag`.
* In preview, the safety label appears beside the endpoint heading and stays out of the sidebar.
* The page says how to verify success and recover from common failures.
* Every path and heading link resolves in `docs.json`.