# Brand Notebook

Client notes and meeting transcripts

## List notebook entries

> List client notes / meeting transcripts for a site. Requires Agency plan or higher.

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Brand Notebook","description":"Client notes and meeting transcripts"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"NotebookEntry":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"content":{"type":"string"},"meeting_date":{"type":"string","format":"date","nullable":true},"source":{"type":"string"},"processing_status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/brands/{siteId}/notebook":{"get":{"summary":"List notebook entries","description":"List client notes / meeting transcripts for a site. Requires Agency plan or higher.","parameters":[{"in":"query","name":"limit","schema":{"type":"integer","default":50}},{"in":"query","name":"offset","schema":{"type":"integer","default":0}},{"in":"query","name":"source","schema":{"type":"string"},"description":"Filter by source (api, manual, etc.)"}],"responses":{"200":{"description":"List of notebook entries","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotebookEntry"}}}}}},"tags":["Brand Notebook"]}}}}
```

## Create a notebook entry

> Add a new client note or meeting transcript. Content is automatically indexed for RAG.

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Brand Notebook","description":"Client notes and meeting transcripts"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"NotebookEntry":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"content":{"type":"string"},"meeting_date":{"type":"string","format":"date","nullable":true},"source":{"type":"string"},"processing_status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/brands/{siteId}/notebook":{"post":{"summary":"Create a notebook entry","description":"Add a new client note or meeting transcript. Content is automatically indexed for RAG.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title","content"],"properties":{"title":{"type":"string","maxLength":500},"content":{"type":"string","maxLength":100000},"meeting_date":{"type":"string","format":"date","nullable":true}}}}}},"responses":{"201":{"description":"Entry created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotebookEntry"}}}}},"tags":["Brand Notebook"]}}}}
```

## GET /v1/brands/{siteId}/notebook/{entryId}

> Get a notebook entry

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Brand Notebook","description":"Client notes and meeting transcripts"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"NotebookEntry":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"content":{"type":"string"},"meeting_date":{"type":"string","format":"date","nullable":true},"source":{"type":"string"},"processing_status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/brands/{siteId}/notebook/{entryId}":{"get":{"summary":"Get a notebook entry","responses":{"200":{"description":"Notebook entry detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotebookEntry"}}}}},"tags":["Brand Notebook"]}}}}
```

## Update a notebook entry

> Update an existing notebook entry. If content changes, it is re-indexed.

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Brand Notebook","description":"Client notes and meeting transcripts"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"NotebookEntry":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"content":{"type":"string"},"meeting_date":{"type":"string","format":"date","nullable":true},"source":{"type":"string"},"processing_status":{"type":"string","enum":["pending","processing","completed","failed"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}}}},"paths":{"/v1/brands/{siteId}/notebook/{entryId}":{"put":{"summary":"Update a notebook entry","description":"Update an existing notebook entry. If content changes, it is re-indexed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"content":{"type":"string","maxLength":100000},"meeting_date":{"type":"string","format":"date","nullable":true}}}}}},"responses":{"200":{"description":"Entry updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotebookEntry"}}}}},"tags":["Brand Notebook"]}}}}
```

## DELETE /v1/brands/{siteId}/notebook/{entryId}

> Delete a notebook entry

```json
{"openapi":"3.1.0","info":{"title":"Cuppa API","version":"1.0.0"},"tags":[{"name":"Brand Notebook","description":"Client notes and meeting transcripts"}],"servers":[{"url":"https://api.cuppa.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY"}}},"paths":{"/v1/brands/{siteId}/notebook/{entryId}":{"delete":{"summary":"Delete a notebook entry","responses":{"204":{"description":"Entry deleted"}},"tags":["Brand Notebook"]}}}}
```


---

# 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/brand-notebook.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.