Base URL
| Environment | URL |
|---|---|
| Production | https://api.app.hrizn.io/v1/public |
Authentication
All endpoints (except/health) require an API key in the X-API-Key header.
The
/health endpoint is the only endpoint that does not require authentication. Use it to verify the API is operational.API Architecture
The API is organized into endpoint groups that work together to power the full content lifecycle:Endpoint groups
IdeaClouds
Create and manage AI-powered keyword research. Start here to build content.
Content Intelligence
AI-powered content gap analysis and recommendations. Identifies what to create next based on inventory, search data, and competitive analysis.
Content
Generate content from IdeaClouds. Retrieve HTML, components, and metadata.
Content Types
Create specialized content: comparisons, model landing pages, and sales events.
Compliance
Run OEM-specific compliance checks on content.
Content Tools
Generate SEO metadata, JSON-LD schemas, and social snippets.
Inventory
Access vehicle data, AI descriptions, and inventory feeds.
Site
Read dealership details, categories, brand voices, and elements.
Webhooks
Manage webhook subscriptions for real-time event delivery.
Reference
Look up content types, component types, webhook events, and scopes.
Common headers
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your API key |
Content-Type | For POST/PATCH | application/json |
X-Idempotency-Key | No | Prevent duplicate POST operations |
Accept | No | application/json (default) or text/html for HTML endpoints |