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

# Create a moodboard

> Starts a moodboard for a product from an optional idea and up to 8 reference images. Moodboards are free. Poll the moodboard until it is `completed`, then use it as `quick_shoot.moodboard_id` or with `moodboard_shots`.



## OpenAPI

````yaml /api/openapi.yaml post /moodboards
openapi: 3.1.0
info:
  title: LocalAds API
  version: 1.0.0
  description: Public API for LocalAds customer integrations.
servers:
  - url: https://makelocalads.com/api/v1
security:
  - apiKey: []
paths:
  /moodboards:
    post:
      summary: Create a moodboard
      description: >-
        Starts a moodboard for a product from an optional idea and up to 8
        reference images. Moodboards are free. Poll the moodboard until it is
        `completed`, then use it as `quick_shoot.moodboard_id` or with
        `moodboard_shots`.
      operationId: createMoodboard
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoodboardCreate'
            example:
              product_id: a1516a75-9be5-461a-93af-c1896a0a3127
              idea: Sunlit Mediterranean terrace, linen and terracotta.
      responses:
        '202':
          description: Moodboard accepted.
          headers:
            Location:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Moodboard'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional caller-generated value that prevents duplicate generation when
        retrying the same request.
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    MoodboardCreate:
      type: object
      additionalProperties: false
      required:
        - product_id
      properties:
        product_id:
          type: string
          format: uuid
        idea:
          type: string
          minLength: 1
          maxLength: 2000
          description: Optional. What the moodboard should explore.
        reference_image_urls:
          type: array
          minItems: 1
          maxItems: 8
          items:
            type: string
            format: uri
            pattern: ^https://
    Moodboard:
      type: object
      required:
        - id
        - product_id
        - status
        - image_url
        - style_name
        - summary
        - idea
        - created_at
      properties:
        id:
          type: string
          format: uuid
        product_id:
          type: string
          format: uuid
          description: The product it was made for.
        status:
          type: string
          enum:
            - queued
            - in_progress
            - completed
            - failed
            - canceled
        image_url:
          type:
            - string
            - 'null'
          format: uri
          description: A 3 x 3 grid. Null until completed.
        style_name:
          type:
            - string
            - 'null'
        summary:
          type:
            - string
            - 'null'
        idea:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The API key lacks the required permission (`insufficient_permission`),
        the organization's plan does not include API access
        (`plan_upgrade_required`; Pro and Enterprise only), or the organization
        is suspended (`org_suspended`).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: Resource not found.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Conflict:
      description: >-
        Idempotency key conflict, an identical request still in progress, or a
        brand already exists for the requested website.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: API key rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: lads_...

````