# Hrizn API Documentation

> Programmatically create content, manage research, and access dealership data with the Hrizn Public API.

## Docs

- [Get compliance results](https://api-docs.hrizn.io/api-reference/compliance/get.md): Get compliance check results for content
- [Get compliance report](https://api-docs.hrizn.io/api-reference/compliance/get-compliance-report.md)
- [Trigger compliance check](https://api-docs.hrizn.io/api-reference/compliance/trigger.md): Run an OEM compliance check on content
- [Trigger compliance check](https://api-docs.hrizn.io/api-reference/compliance/trigger-compliance-check.md): Starts an asynchronous OEM compliance check on content.
- [Act on recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/act.md): Link a recommendation to the article created from it
- [Act on recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/act-on-recommendation.md): Marks a recommendation as acted on, linking it to the article that was created from this recommendation.
- [Bulk dismiss](https://api-docs.hrizn.io/api-reference/content-intelligence/bulk-dismiss.md): Dismiss multiple content intelligence recommendations at once
- [Dismiss recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/dismiss.md): Dismiss a content intelligence recommendation
- [Dismiss recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/dismiss-recommendation.md): Marks a recommendation as dismissed, removing it from the active list.
- [Get recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/get.md): Get details of a specific content intelligence recommendation
- [Get recommendation](https://api-docs.hrizn.io/api-reference/content-intelligence/get-recommendation.md): Returns a single content intelligence recommendation by ID.
- [Get summary](https://api-docs.hrizn.io/api-reference/content-intelligence/get-summary.md): Returns aggregate counts of content intelligence recommendations by status, priority tier, and type.
- [List recommendations](https://api-docs.hrizn.io/api-reference/content-intelligence/list.md): List AI-generated content intelligence recommendations for this site
- [List recommendations](https://api-docs.hrizn.io/api-reference/content-intelligence/list-recommendations.md): Returns a paginated list of content intelligence recommendations generated by the nightly gap analysis pipeline.
- [Get summary](https://api-docs.hrizn.io/api-reference/content-intelligence/summary.md): Get aggregate counts of content intelligence recommendations
- [Generate content tools](https://api-docs.hrizn.io/api-reference/content-tools/generate.md): Generate SEO metadata, schemas, and social snippets for content
- [Generate a single content tool](https://api-docs.hrizn.io/api-reference/content-tools/generate-a-single-content-tool.md)
- [Generate content tools](https://api-docs.hrizn.io/api-reference/content-tools/generate-content-tools.md): Triggers generation for all or selected content tools on content.
- [Create vehicle comparison](https://api-docs.hrizn.io/api-reference/content-types/create-comparison.md): Generate a side-by-side vehicle comparison article
- [Create model landing page](https://api-docs.hrizn.io/api-reference/content-types/create-model-landing.md): Generate a model research / landing page for a specific vehicle
- [Create sales event page](https://api-docs.hrizn.io/api-reference/content-types/create-sales-event.md): Generate a promotional page for a dealership event
- [Create content](https://api-docs.hrizn.io/api-reference/content/create.md): Generate content from a completed IdeaCloud
- [Create content (batch)](https://api-docs.hrizn.io/api-reference/content/create-batch.md): Create up to 10 content items in a single request
- [Create content](https://api-docs.hrizn.io/api-reference/content/create-content.md): Creates new content from a completed IdeaCloud.
- [Create content in batch](https://api-docs.hrizn.io/api-reference/content/create-content-in-batch.md): Creates multiple content items in a single request (1-10 items).
- [Create model landing page](https://api-docs.hrizn.io/api-reference/content/create-model-landing-page.md): Creates a model research / landing page for a specific vehicle (year, make, model). The page is generated asynchronously. Use the returned `id` with `GET /content/{id}` to check status and retrieve the result.
- [Create sales event page](https://api-docs.hrizn.io/api-reference/content/create-sales-event-page.md): Creates a promotional page for a dealership sales event. Supports various event categories including Sales Events, New Model Launches, Service Specials, and more. The page is generated asynchronously. Use the returned `id` with `GET /content/{id}` to check status and retrieve the result.
- [Create vehicle comparison](https://api-docs.hrizn.io/api-reference/content/create-vehicle-comparison.md): Creates a vehicle comparison comparing 2-5 vehicles side-by-side. The comparison is generated asynchronously. Use the returned `id` with `GET /content/{id}` to check status and retrieve the result.
- [Generate content](https://api-docs.hrizn.io/api-reference/content/generate.md): Submit inputs and trigger content generation (interactive mode)
- [Generate interactive-mode content](https://api-docs.hrizn.io/api-reference/content/generate-interactive-mode-content.md): Triggers generation for content created in interactive mode.
- [Get content](https://api-docs.hrizn.io/api-reference/content/get.md): Get details and component status of content
- [Get a single component](https://api-docs.hrizn.io/api-reference/content/get-a-single-component.md)
- [Get all components](https://api-docs.hrizn.io/api-reference/content/get-all-components.md)
- [Get CMS-ready HTML](https://api-docs.hrizn.io/api-reference/content/get-cms-ready-html.md): Returns the content body as CMS-ready HTML. For standard (markdown-based) articles the output includes Bootstrap table classes for responsive styling and a Hrizn attribution tag, matching the HTML produced by the "Copy to CMS" feature in the dashboard. For visual builder articles (created with the H…
- [Get content components](https://api-docs.hrizn.io/api-reference/content/get-components.md): Get all components or a specific component type
- [Get content details](https://api-docs.hrizn.io/api-reference/content/get-content-details.md)
- [Get content HTML](https://api-docs.hrizn.io/api-reference/content/get-html.md): Get the CMS-ready HTML body of content
- [Get publish data](https://api-docs.hrizn.io/api-reference/content/get-publish-data.md): Get the complete publish payload for CMS integration
- [List content](https://api-docs.hrizn.io/api-reference/content/list.md): List all content for this site
- [List content](https://api-docs.hrizn.io/api-reference/content/list-content.md)
- [List published content](https://api-docs.hrizn.io/api-reference/content/list-published.md): List content that is published or scheduled
- [List published content](https://api-docs.hrizn.io/api-reference/content/list-published-content.md): Returns a paginated list of content with posting_status of published or scheduled.
- [Deprecated: Cancel GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/cancel.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Create GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/create.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Delete GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/delete.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Cancel a scheduled GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-cancel-a-scheduled-gbp-post.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Create a GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-create-a-gbp-post.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Delete a GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-delete-a-gbp-post.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Get a GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-get-a-gbp-post.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: List GBP posts](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-list-gbp-posts.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Reschedule a GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/deprecated:-reschedule-a-gbp-post.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Get GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/get.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: List GBP posts](https://api-docs.hrizn.io/api-reference/gbp-posts/list.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: Reschedule GBP post](https://api-docs.hrizn.io/api-reference/gbp-posts/reschedule.md): Deprecated. The public GBP posting API is no longer available.
- [Health check](https://api-docs.hrizn.io/api-reference/health/health-check.md)
- [Create IdeaCloud](https://api-docs.hrizn.io/api-reference/ideaclouds/create.md): Start AI-powered keyword research on a topic
- [Create IdeaClouds (batch)](https://api-docs.hrizn.io/api-reference/ideaclouds/create-batch.md): Create up to 25 IdeaClouds in a single request
- [Create IdeaCloud](https://api-docs.hrizn.io/api-reference/ideaclouds/create-ideacloud.md): Creates a new IdeaCloud and begins AI-powered keyword research.
- [Create IdeaClouds in batch](https://api-docs.hrizn.io/api-reference/ideaclouds/create-ideaclouds-in-batch.md): Creates multiple IdeaClouds in a single request (1-25 items).
- [Get IdeaCloud](https://api-docs.hrizn.io/api-reference/ideaclouds/get.md): Get details and status of a specific IdeaCloud
- [Get IdeaCloud details](https://api-docs.hrizn.io/api-reference/ideaclouds/get-ideacloud-details.md)
- [Get IdeaCloud questions](https://api-docs.hrizn.io/api-reference/ideaclouds/get-questions.md): Get the researched questions and clusters from an IdeaCloud
- [Get questions and clusters](https://api-docs.hrizn.io/api-reference/ideaclouds/get-questions-and-clusters.md): Returns research questions and clusters. If research is in progress, arrays are empty.
- [List IdeaClouds](https://api-docs.hrizn.io/api-reference/ideaclouds/list.md): List all IdeaClouds for this site
- [List IdeaClouds](https://api-docs.hrizn.io/api-reference/ideaclouds/list-ideaclouds.md): Returns a paginated list of IdeaClouds for your site.
- [Generate AI description](https://api-docs.hrizn.io/api-reference/inventory/generate-ai-description.md): Triggers AI description generation for a single vehicle.
- [Generate description](https://api-docs.hrizn.io/api-reference/inventory/generate-description.md): Trigger AI description generation for a vehicle
- [Generate descriptions (batch)](https://api-docs.hrizn.io/api-reference/inventory/generate-description-batch.md): Trigger description generation for up to 50 vehicles
- [Generate descriptions in batch](https://api-docs.hrizn.io/api-reference/inventory/generate-descriptions-in-batch.md): Triggers AI description generation for multiple vehicles (1-50 VINs).
- [Get AI description](https://api-docs.hrizn.io/api-reference/inventory/get-ai-description.md)
- [Get vehicle description](https://api-docs.hrizn.io/api-reference/inventory/get-description.md): Get the AI-generated description for a vehicle
- [Get inventory feed](https://api-docs.hrizn.io/api-reference/inventory/get-feed.md): Get the complete inventory feed in JSON or XML format
- [Get inventory feed](https://api-docs.hrizn.io/api-reference/inventory/get-inventory-feed.md): Returns the complete inventory feed in JSON or XML format.
- [Get inventory stats](https://api-docs.hrizn.io/api-reference/inventory/get-inventory-stats.md)
- [Get inventory stats](https://api-docs.hrizn.io/api-reference/inventory/get-stats.md): Get aggregate inventory statistics
- [Get vehicle](https://api-docs.hrizn.io/api-reference/inventory/get-vehicle.md): Get full details for a specific vehicle
- [Get vehicle details](https://api-docs.hrizn.io/api-reference/inventory/get-vehicle-details.md)
- [List inventory](https://api-docs.hrizn.io/api-reference/inventory/list.md): List vehicles in this site's inventory
- [List vehicles](https://api-docs.hrizn.io/api-reference/inventory/list-vehicles.md)
- [API reference](https://api-docs.hrizn.io/api-reference/overview.md): Complete reference for all Hrizn Public API endpoints
- [Component types](https://api-docs.hrizn.io/api-reference/reference/component-types.md): List all article component types
- [Content intelligence types](https://api-docs.hrizn.io/api-reference/reference/content-intelligence-types.md): List all content intelligence recommendation types with descriptions and recommended actions
- [Content tools](https://api-docs.hrizn.io/api-reference/reference/content-tools.md): List all content tool types
- [Content types](https://api-docs.hrizn.io/api-reference/reference/content-types.md): List all available content types
- [Health check](https://api-docs.hrizn.io/api-reference/reference/health.md): Check if the API is operational
- [List available scopes](https://api-docs.hrizn.io/api-reference/reference/list-available-scopes.md)
- [List component types](https://api-docs.hrizn.io/api-reference/reference/list-component-types.md)
- [List content intelligence types](https://api-docs.hrizn.io/api-reference/reference/list-content-intelligence-types.md): Returns all recommendation types generated by the content intelligence pipeline, with descriptions and recommended action endpoints.
- [List content tools](https://api-docs.hrizn.io/api-reference/reference/list-content-tools.md)
- [List content types](https://api-docs.hrizn.io/api-reference/reference/list-content-types.md)
- [List webhook event types](https://api-docs.hrizn.io/api-reference/reference/list-webhook-event-types.md)
- [Scopes](https://api-docs.hrizn.io/api-reference/reference/scopes.md): List all API key scopes
- [Webhook events](https://api-docs.hrizn.io/api-reference/reference/webhook-events.md): List all webhook event types
- [Get site](https://api-docs.hrizn.io/api-reference/site/get.md): Get details about the site associated with this API key
- [Get brand voices](https://api-docs.hrizn.io/api-reference/site/get-brand-voices.md): List brand voices available for this site
- [Get categories](https://api-docs.hrizn.io/api-reference/site/get-categories.md): List content categories for this site
- [Get content disclaimers](https://api-docs.hrizn.io/api-reference/site/get-content-disclaimers.md): Returns content disclaimers configured for the site
- [Get content types](https://api-docs.hrizn.io/api-reference/site/get-content-types.md): List content types enabled for this site
- [Get Dealer DNA](https://api-docs.hrizn.io/api-reference/site/get-dealer-dna.md): Returns the dealership's DNA profile — history, mission, values, and more
- [Get elements](https://api-docs.hrizn.io/api-reference/site/get-elements.md): List all raw site elements (staff, links, target geographies, etc.)
- [Get site links](https://api-docs.hrizn.io/api-reference/site/get-links.md): Returns all configured dealership links
- [Get marketing artifacts](https://api-docs.hrizn.io/api-reference/site/get-marketing.md): Returns all marketing artifacts configured for the site
- [Get site details](https://api-docs.hrizn.io/api-reference/site/get-site-details.md)
- [Get staff members](https://api-docs.hrizn.io/api-reference/site/get-staff.md): Returns all staff members configured for the dealership
- [Get target geography](https://api-docs.hrizn.io/api-reference/site/get-target-geography.md): Returns all target geography locations with boundaries and AI-generated profiles
- [List brand voices](https://api-docs.hrizn.io/api-reference/site/list-brand-voices.md)
- [List categories](https://api-docs.hrizn.io/api-reference/site/list-categories.md)
- [List content disclaimers](https://api-docs.hrizn.io/api-reference/site/list-content-disclaimers.md): Returns all content disclaimers configured for the site.
- [List content types](https://api-docs.hrizn.io/api-reference/site/list-content-types.md)
- [List marketing artifacts](https://api-docs.hrizn.io/api-reference/site/list-marketing-artifacts.md): Returns all marketing artifacts (evergreen messages, why-buys, custom USPs).
- [List site elements](https://api-docs.hrizn.io/api-reference/site/list-site-elements.md)
- [List site links](https://api-docs.hrizn.io/api-reference/site/list-site-links.md): Returns all dealership links (SRP pages, service scheduler, credit application, etc.).
- [List staff members](https://api-docs.hrizn.io/api-reference/site/list-staff-members.md): Returns all staff members configured for the dealership.
- [List target geography](https://api-docs.hrizn.io/api-reference/site/list-target-geography.md): Returns all target geography locations with boundaries and AI-generated location profiles.
- [Create webhook](https://api-docs.hrizn.io/api-reference/webhooks/create.md): Create a webhook subscription
- [Create webhook subscription](https://api-docs.hrizn.io/api-reference/webhooks/create-webhook-subscription.md): Creates a new webhook. The response includes a secret for HMAC verification (only shown once).
- [Delete webhook](https://api-docs.hrizn.io/api-reference/webhooks/delete.md): Delete a webhook subscription
- [Delete webhook subscription](https://api-docs.hrizn.io/api-reference/webhooks/delete-webhook-subscription.md)
- [Get webhook deliveries](https://api-docs.hrizn.io/api-reference/webhooks/deliveries.md): View delivery log for a webhook subscription
- [Get delivery logs](https://api-docs.hrizn.io/api-reference/webhooks/get-delivery-logs.md)
- [List webhooks](https://api-docs.hrizn.io/api-reference/webhooks/list.md): List all webhook subscriptions for this site
- [List webhook subscriptions](https://api-docs.hrizn.io/api-reference/webhooks/list-webhook-subscriptions.md)
- [Send test ping](https://api-docs.hrizn.io/api-reference/webhooks/send-test-ping.md): Sends a synchronous test.ping event to the webhook URL.
- [Test webhook](https://api-docs.hrizn.io/api-reference/webhooks/test.md): Send a test event to a webhook endpoint
- [Update webhook](https://api-docs.hrizn.io/api-reference/webhooks/update.md): Update a webhook subscription
- [Update webhook subscription](https://api-docs.hrizn.io/api-reference/webhooks/update-webhook-subscription.md)
- [Authentication](https://api-docs.hrizn.io/authentication.md): How to authenticate with the Hrizn Public API
- [Errors](https://api-docs.hrizn.io/concepts/errors.md): Error response format and error codes
- [Idempotency](https://api-docs.hrizn.io/concepts/idempotency.md): Safely retry requests without duplicate side effects
- [Pagination](https://api-docs.hrizn.io/concepts/pagination.md): Navigate through large result sets
- [Scopes](https://api-docs.hrizn.io/concepts/scopes.md): Control what each API key can access
- [Bulk Content Generation](https://api-docs.hrizn.io/guides/bulk-content-generation.md): Generate hundreds of articles across multiple sites while respecting rate limits
- [Content Intelligence](https://api-docs.hrizn.io/guides/content-intelligence.md): Automate content gap analysis and act on AI-generated recommendations via the API
- [Deprecated: GBP Posting API](https://api-docs.hrizn.io/guides/gbp-posting.md): The public Google Business Profile posting API is no longer supported
- [Hrizn Public API](https://api-docs.hrizn.io/index.md): Programmatically create content, manage research, and access dealership data
- [Quickstart](https://api-docs.hrizn.io/quickstart.md): Make your first API call in 5 minutes
- [Rate Limiting](https://api-docs.hrizn.io/rate-limiting.md): Understand and work with API rate limits
- [compliance:write](https://api-docs.hrizn.io/scopes/compliance-write.md): Trigger OEM compliance checks on generated articles
- [content_intelligence:read](https://api-docs.hrizn.io/scopes/content-intelligence-read.md): List and view content intelligence recommendations, dismiss recommendations
- [content_intelligence:write](https://api-docs.hrizn.io/scopes/content-intelligence-write.md): Act on recommendations and bulk-dismiss
- [content:read](https://api-docs.hrizn.io/scopes/content-read.md): List and retrieve content, HTML content, components, and compliance reports
- [content_tools:write](https://api-docs.hrizn.io/scopes/content-tools-write.md): Generate SEO metadata, JSON-LD schemas, social snippets, and other content tools
- [content:write](https://api-docs.hrizn.io/scopes/content-write.md): Create content and trigger generation from IdeaClouds
- [Deprecated: gbp:read](https://api-docs.hrizn.io/scopes/gbp-read.md): Deprecated. The public GBP posting API is no longer available.
- [Deprecated: gbp:write](https://api-docs.hrizn.io/scopes/gbp-write.md): Deprecated. The public GBP posting API is no longer available.
- [ideaclouds:read](https://api-docs.hrizn.io/scopes/ideaclouds-read.md): List and retrieve IdeaClouds, research questions, and question clusters
- [ideaclouds:write](https://api-docs.hrizn.io/scopes/ideaclouds-write.md): Create IdeaClouds individually or in batch to start keyword research
- [inventory:read](https://api-docs.hrizn.io/scopes/inventory-read.md): List vehicles, view AI descriptions, access inventory feeds, and check stats
- [inventory:write](https://api-docs.hrizn.io/scopes/inventory-write.md): Trigger AI description generation for individual vehicles or in batch
- [Scopes Overview](https://api-docs.hrizn.io/scopes/overview.md): Understand how scopes control API key permissions and which endpoints each scope unlocks
- [site:read](https://api-docs.hrizn.io/scopes/site-read.md): View site details, categories, brand voices, elements, and content types
- [webhooks:read](https://api-docs.hrizn.io/scopes/webhooks-read.md): List webhook subscriptions and view delivery logs
- [webhooks:write](https://api-docs.hrizn.io/scopes/webhooks-write.md): Create, update, delete, and test webhook subscriptions
- [Webhooks](https://api-docs.hrizn.io/webhooks.md): Receive real-time notifications when content is ready

## OpenAPI Specs

- [openapi](https://api-docs.hrizn.io/openapi.yaml)

## Optional

- [Dashboard](https://app.hrizn.io)
- [Support](mailto:support@hrizn.io)