Create manual API pages

Manual API pages are useful for small APIs, prototypes, composite workflows, or any endpoint page that needs more narrative than a generated reference page can provide.

​

Configure shared defaults

Set a shared base URL and auth method in layout.json so individual pages can use relative paths.

{
  "api": {
    "baseUrl": "https://docsalot.dev/api/cli/v1",
    "auth": {
      "method": "bearer"
    },
    "playground": {
      "display": "interactive"
    }
  }
}

​

Create a page

Add an MDX file and declare the endpoint with api:.

---
title: "Create documentation"
description: "Create a new Docsalot documentation project."
api: "POST /documentations"
---

Use this endpoint when you want to create a new documentation site for a repository.

You can also use a full URL instead of a relative path.

---
title: "Health check"
api: "GET https://api.example.com/health"
---

​

Override auth per page

If one page needs different auth behavior, set it in page metadata.

---
title: "Public status"
api: "GET /status"
authMethod: "none"
---

​

When manual pages work best

• onboarding or quickstart endpoints
• multi-step workflows that need extra explanation
• early beta APIs that are moving too quickly for a stable spec
• pages that combine examples, caveats, and support notes

Use OpenAPI setup when you want schema-driven parameters and responses to stay in sync automatically.