docs: simplify API workspace documentation

[Kzoeps]

Summary

• Replace the workspace README's endpoint inventories with a concise directory guide, checks, and HappyView install requirements.
• Trim endpoint-by-endpoint details from the API README and point readers to the explorer and OpenAPI reference.
• Add agent guidance to keep endpoint documentation and explorer artifacts aligned with API changes.

Validation

• Markdown link and heading-anchor checks
• Test suites not run (documentation-only changes).

[changeset-bot]

⚠️ No Changeset found

Latest commit: a1f8317

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
api-endpoints	Ready	Preview	Oct 6, 2026 5:23pm UTC

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 34 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: e1ce9325-35b9-46ee-bf46-c20fd99fd1a0

📥 Commits

Reviewing files that changed from the base of the PR and between e9fcc42 and a1f8317.

📒 Files selected for processing (3)

• AGENTS.md
• README.md
• api/README.md

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud