openmates:add-api

API provider integration is achieved through a research-first workflow that generates an async httpx wrapper with retry and rate-limit handling. It enforces provider-scoped code boundaries by creating a dedicated directory containing a pure API client and response schemas.

The best way to structure an API wrapper is by separating concerns into a pure client for requests and a models file for response schemas. This provider-grade architecture ensures clean code boundaries and validated endpoints for third-party service integration.

Vault secrets for API authentication are managed using a vault-first secret loading mechanism with an environment variable fallback. This approach secures API keys and credentials while maintaining accessibility during local development or fallback scenarios.

Yes, adding a new API integration requires privacy and legal checks. The workflow includes operational tooling that generates provider documentation and explicitly prompts for privacy and legal reviews before finalizing the external service integration.

You can automate API documentation and test script generation through the provider integration workflow. It automatically generates a dedicated test script and full provider documentation alongside the API wrapper to validate endpoints and response schemas.