SDKs and AI coding agents

Supported Go and TypeScript clients are generated from the same reviewed OpenAPI document used by contract checks. Pin SDK versions and review the public changelog before upgrading.

Machine-readable sources

1. Use OpenAPI 3 JSON as the operation and schema authority.
2. Use the Markdown guides for authentication, compatibility, and retry policy.
3. Use llms.txt as the documentation index for coding agents.
4. Reference credentials by environment-variable or secret-store name.
5. Preserve generated operation IDs so code remains searchable across SDKs.

The public Swagger UI is intentionally read-only. Execute requests from a server-side development environment or the authenticated Portal console. Agents must never request that API-key values be pasted into prompts.

The Markdown version of this guide and the public API changelog remain available for tools and compatibility consumers.