Skip to content

docs: improve agent API guidance and no-key operation discoverability#109

Merged
openoms merged 1 commit intomainfrom
docs/agent-api-reference-guardrails
Mar 26, 2026
Merged

docs: improve agent API guidance and no-key operation discoverability#109
openoms merged 1 commit intomainfrom
docs/agent-api-reference-guardrails

Conversation

@openoms
Copy link
Copy Markdown
Collaborator

@openoms openoms commented Mar 26, 2026

Summary

  • add an AI agent playbook with explicit fallback behavior: if unclear, check API reference first
  • add a dedicated no-key operations page focused on relevant unauthenticated invoice/status and public query flows
  • improve discoverability via sidebar and cross-links from auth and LLM reference pages
  • add llms.txt with canonical sources and hard rules for AI agents

Details

  • new: docs/api/agent-playbook.md
  • new: docs/api/no-api-key-operations.md
  • new: static/llms.txt
  • updated: docs/api/auth.mdx
  • updated: docs/api/llm-api-reference.md
  • updated: sidebars.js

No-Key Operations Scope

  • included invoice-on-behalf mutations
  • included status/default-wallet queries
  • included public queries: btcPriceList, businessMapMarkers
  • excluded auth bootstrap mutations from this page (captchaCreateChallenge, captchaRequestAuthCode, userLogin)

Validation

  • yarn build passes locally

@openoms openoms merged commit 6ff7dd7 into main Mar 26, 2026
2 checks passed
@openoms openoms deleted the docs/agent-api-reference-guardrails branch March 26, 2026 11:23
@openoms openoms requested review from k9ert and pretyflaco March 26, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant