> ## 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.

# Retrieve a moodboard

> Returns a moodboard's status and, once completed, its image.



## OpenAPI

````yaml /api/openapi.yaml get /moodboards/{moodboard_id}
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: []
tags:
  - name: Account
    description: Your organization, balance and prices.
  - name: Set up
    description: Brands, products, audiences and image uploads.
  - name: Ad campaigns
    description: Campaigns and their creatives.
  - name: Listing images
    description: Amazon listing image ideas and renders.
  - name: Photoshoots
    description: Photoshoots, templates and moodboards.
  - name: ChatGPT ads
    description: ChatGPT ad groups and ads.
  - name: UGC videos
    description: Recipes, concepts, voices and videos.
  - name: Creatives
    description: The cross-type list of finished images and videos.
paths:
  /moodboards/{moodboard_id}:
    parameters:
      - name: moodboard_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Photoshoots
      summary: Retrieve a moodboard
      description: Returns a moodboard's status and, once completed, its image.
      operationId: getMoodboard
      responses:
        '200':
          description: Moodboard found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Moodboard'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    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:
    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'
    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_...

````