Using the API with AI

AI tools that understand OpenAPI can use the HIO public contract to discover operations, parameters, and response schemas.

Machine-readable contract

Use the generated HIO public OpenAPI document. It contains only operations approved for customer use and is refreshed whenever this documentation site builds.

Typical uses include:

• attaching the contract as context when asking an assistant to write integration code;
• importing the contract into an agent or tool that supports OpenAPI actions;
• generating a typed client before asking an assistant to work against that client;
• validating that an AI-generated request uses a supported path and request shape.

Safety boundaries

• The contract describes capabilities; it does not provide credentials or bypass authorization.
• Give an AI tool only the credentials and data its execution environment is approved to handle.
• Prefer short-lived or narrowly scoped credentials when automated tools will execute requests.
• Review write and delete operations before allowing autonomous execution.
• Do not provide developer-notes, the internal OpenAPI contract, or HIO-only endpoints to customer-facing tools.

For code generation, pin the downloaded contract with the generated client so contract changes can be reviewed like source changes.