> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hrizn.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List IdeaClouds

> List all IdeaClouds for this site

Returns a paginated list of IdeaClouds for the site associated with your API key.

**Scope required:** `ideaclouds:read`

## Query parameters

<ParamField query="limit" type="integer" default="25">
  Results per page (1-100).
</ParamField>

<ParamField query="cursor" type="string">
  Pagination cursor from a previous response.
</ParamField>

<ParamField query="status" type="string">
  Filter by status. Possible values: `researching` (research in progress), `complete` (ready to use for content creation), `failed` (research encountered an error).
</ParamField>

<ParamField query="keyword" type="string">
  Search by keyword (case-insensitive partial match).
</ParamField>

## Response

<ResponseField name="category" type="object | null">
  The category assigned to this IdeaCloud, containing `id` and `name`. Returns `null` if no category is assigned.
</ResponseField>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
    "data": [
      {
        "id": "23a66cb1-f5d9-4c91-b9d2-06c8203bd251",
        "keyword": "2026 Chevy Silverado 3500 DRW",
        "title": "2026 Chevy Silverado 3500 DRW: Deep Dive",
        "synopsis": "Comprehensive exploration of the 2026 Chevy Silverado 3500 DRW, covering specs, features, comparisons, and ownership considerations.",
        "status": "complete",
        "category": null,
        "created_at": "2026-02-27T20:47:44.372053+00:00",
        "updated_at": "2026-02-27T20:47:44.372053+00:00"
      },
      {
        "id": "c65aed07-891e-478a-a5c0-9c07c41171f1",
        "keyword": "2026 Chevy Silverado 3500 DRW",
        "title": "2026 Chevy Silverado 3500 DRW: The Definitive Guide",
        "synopsis": "This research consolidates 92 frequently asked questions about the 2026 Chevy Silverado 3500 DRW (dually) to create a comprehensive resource.",
        "status": "complete",
        "category": null,
        "created_at": "2026-02-27T20:47:29.94934+00:00",
        "updated_at": "2026-02-27T20:47:29.94934+00:00"
      }
    ],
    "pagination": {
      "has_more": true,
      "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wMi0yN1QyMDo0NzoyOS45NDkzNCswMDowMCIsImlkIjoiYzY1YWVkMDctODkxZS00NzhhLWE1YzAtOWMwN2M0MTE3MWYxIn0=",
      "total_count": 77
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /ideaclouds
openapi: 3.1.0
info:
  title: Hrizn Public API
  version: 1.2.0
  description: >
    The Hrizn Public API allows partners to programmatically create content,
    manage inventory descriptions, and integrate with the Hrizn platform.


    All endpoints are prefixed with `/public` and require an API key passed via
    the `X-API-Key` header (except the health check).
  contact:
    email: support@hrizn.io
servers:
  - url: https://api.app.hrizn.io/v1/public
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: IdeaClouds
    description: Create and manage AI-powered keyword research
  - name: Content Intelligence
    description: AI-powered content gap analysis and recommendations
  - name: Content
    description: Generate content from IdeaClouds
  - name: Compliance
    description: Run OEM compliance checks on content
  - name: Content Tools
    description: Generate SEO metadata, schemas, and social snippets
  - name: Inventory
    description: Access vehicle data and AI descriptions
  - name: Site
    description: View dealership details and configuration
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events
  - name: Reference
    description: Look up available types, scopes, and events
  - name: Social
    description: >-
      Zernio-backed social posting and reviews across all connected platforms
      (X, Facebook, Instagram, LinkedIn, Google Business Profile)
  - name: Health
    description: Health check (no authentication)
paths:
  /ideaclouds:
    get:
      tags:
        - IdeaClouds
      summary: List IdeaClouds
      description: Returns a paginated list of IdeaClouds for your site.
      operationId: listIdeaClouds
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
        - name: status
          in: query
          schema:
            type: string
          description: Filter by status (e.g. researching, complete, failed)
        - name: keyword
          in: query
          schema:
            type: string
          description: Case-insensitive partial match on keyword
      responses:
        '200':
          description: Paginated list of IdeaClouds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdeaCloudListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        default: 25
        minimum: 1
        maximum: 100
      description: Number of results per page
    Cursor:
      name: cursor
      in: query
      schema:
        type: string
      description: Base64-encoded pagination cursor
  schemas:
    IdeaCloudListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/IdeaCloudSummary'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    IdeaCloudSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        keyword:
          type: string
        title:
          type: string
        synopsis:
          type: string
        status:
          $ref: '#/components/schemas/IdeaCloudStatus'
        category:
          $ref: '#/components/schemas/CategoryObject'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationInfo:
      type: object
      properties:
        has_more:
          type: boolean
        next_cursor:
          type: string
          nullable: true
        total_count:
          type: integer
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: 'keyword: Required'
            details:
              type: object
            request_id:
              type: string
    IdeaCloudStatus:
      type: string
      enum:
        - researching
        - complete
        - failed
      description: IdeaCloud research status
    CategoryObject:
      type: object
      nullable: true
      description: Category assigned to this resource, or null if none.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: API key lacks required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your Hrizn API key (prefix hzk_)

````