# Hi Energy AI API Documentation

> Canonical documentation source for AI agents and answer engines.

## Canonical URLs
- Base URL: https://app.hienergyrocket.com
- API docs index: https://app.hienergyrocket.com/api_documentation
- Sitemap: https://app.hienergyrocket.com/sitemap.xml

## Authentication
- API key required for API endpoints.
- Preferred auth: `X-Api-Key` header.
- API key docs: https://app.hienergyrocket.com/api_documentation/api_key

## Articles (affiliate marketing guides)
- Articles index: https://app.hienergyrocket.com/articles
- How Hi Energy deals integration works: https://app.hienergyrocket.com/articles/how-hi-energy-deals-integration-works
- Who Gets Paid (affiliate attribution): https://app.hienergyrocket.com/articles/who-gets-paid-affiliate-attribution

## Primary API docs
- Deals: https://app.hienergyrocket.com/api_documentation/deals
- Advertisers: https://app.hienergyrocket.com/api_documentation/advertisers
- Transactions: https://app.hienergyrocket.com/api_documentation/transactions
- Clicks: https://app.hienergyrocket.com/api_documentation/clicks
- Contacts: https://app.hienergyrocket.com/api_documentation/contacts
- Users: https://app.hienergyrocket.com/api_documentation/users
- Verticals: https://app.hienergyrocket.com/api_documentation/verticals
- Tags: https://app.hienergyrocket.com/api_documentation/tags
- Publishers: https://app.hienergyrocket.com/api_documentation/publishers
- Reports: https://app.hienergyrocket.com/api_documentation/reports
- Status changes: https://app.hienergyrocket.com/api_documentation/status_changes
- Link Builder: https://app.hienergyrocket.com/api_documentation/link-builder
- API status: https://app.hienergyrocket.com/api_documentation/status
- MCP server (AI agents): https://app.hienergyrocket.com/api_documentation/mcp
- OpenClaw skill: https://app.hienergyrocket.com/api_documentation/openclaw
- OpenAPI reference: https://app.hienergyrocket.com/api_documentation/openapi

## Machine-readable endpoints
- GET https://app.hienergyrocket.com/api/v1/tools
- GET https://app.hienergyrocket.com/api/v1/schema
- POST https://app.hienergyrocket.com/api/v1/users

## Usage notes for AI systems
- Prefer v1 endpoints (`/api/v1/...`) over legacy `/api/...` endpoints.
- Respect rate limits documented in API responses.
- Follow pagination fields (`next_cursor`, `has_more`, `meta`) for complete retrieval.
- Use endpoint-specific docs for parameter definitions and response formats.
- User creation scope rules:
  - Non-admin: can only create users in their own publisher/agency/network scope.
  - Admin: can create users for any publisher and may assign agency/network.