# Mood Board

Visual inspiration mood boards

## GET /v1/mood-board

> List mood boards

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Mood Board","description":"Visual inspiration mood boards"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"MoodBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"site_id":{"type":"string","format":"uuid","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/mood-board":{"get":{"summary":"List mood boards","parameters":[{"in":"query","name":"site_id","schema":{"type":"string","format":"uuid"},"description":"Filter by site ID"}],"responses":{"200":{"description":"A list of mood boards","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MoodBoard"}}}}}},"tags":["Mood Board"]}}}}
```

## POST /v1/mood-board

> Create mood board

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Mood Board","description":"Visual inspiration mood boards"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"MoodBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"site_id":{"type":"string","format":"uuid","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/mood-board":{"post":{"summary":"Create mood board","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"site_id":{"type":"string","format":"uuid"}}}}}},"responses":{"201":{"description":"Mood board created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoodBoard"}}}}},"tags":["Mood Board"]}}}}
```

## GET /v1/mood-board/{id}

> Get mood board with items

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Mood Board","description":"Visual inspiration mood boards"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"MoodBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"site_id":{"type":"string","format":"uuid","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/mood-board/{id}":{"get":{"summary":"Get mood board with items","responses":{"200":{"description":"Mood board with items","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MoodBoard"},{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"url":{"type":"string","nullable":true},"metadata":{"type":"object","nullable":true}}}}}}]}}}}},"tags":["Mood Board"]}}}}
```

## DELETE /v1/mood-board/{id}

> Delete mood board

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Mood Board","description":"Visual inspiration mood boards"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/v1/mood-board/{id}":{"delete":{"summary":"Delete mood board","responses":{"200":{"description":"Mood board deleted","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"boolean"}}}}}}},"tags":["Mood Board"]}}}}
```

## Generate mood board images

> Generate mood board images and colors from brand context. Requires Replicate API key.

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Mood Board","description":"Visual inspiration mood boards"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/v1/mood-board/generate":{"post":{"summary":"Generate mood board images","description":"Generate mood board images and colors from brand context. Requires Replicate API key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["mood_board_id","site_id"],"properties":{"mood_board_id":{"type":"string","format":"uuid"},"site_id":{"type":"string","format":"uuid"}}}}}},"responses":{"200":{"description":"Generation result","content":{"application/json":{"schema":{"type":"object","description":"Generation result with generated images and colors"}}}}},"tags":["Mood Board"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.cuppa.ai/rest-api/mood-board.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
