Skip to main content

YODI API Reference

Welcome to the curated YODI API reference for customer and developer integrations. It documents supported public operations, not every backend controller. Administrative, staff-only, operational, and internal documentation endpoints are intentionally excluded. Internal staff can open the protected Swagger UI on the API host. It requires an existing Yodi account and an active, individually granted staff allowlist entry managed in Yodi Admin. The generated OpenAPI JSON is not published or downloadable here.

Documentation sections​

Customer and Developer API Reference​

Curated routes and contracts for supported Yodi services, including authentication, idempotency, pricing units, and response envelopes.

Quick start​

To get started with the YODI API:

  1. Obtain your API key — Sign up on our platform
  2. Read the authentication guide — Learn how to authenticate requests
  3. Test your first call — Use our code examples
  4. Review service contracts — Integrate the Yodi service operation you need.

Useful resources​