Brand Notebook

Client notes and meeting transcripts

List notebook entries

get

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

Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired

Site ID

Query parameters
limitintegerOptionalDefault: 50
offsetintegerOptionalDefault: 0
sourcestringOptional

Filter by source (api, manual, etc.)

Responses
chevron-right
200

List of notebook entries

application/json
get
/v1/brands/{siteId}/notebook
200

List of notebook entries

Create a notebook entry

post

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

Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired

Site ID

Body
titlestring · max: 500Required
contentstring · max: 100000Required
meeting_datestring · date · nullableOptional
Responses
post
/v1/brands/{siteId}/notebook
201

Entry created

Get a notebook entry

get
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
entryIdstring · uuidRequired
Responses
chevron-right
200

Notebook entry detail

application/json
get
/v1/brands/{siteId}/notebook/{entryId}
200

Notebook entry detail

Update a notebook entry

put

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

Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
entryIdstring · uuidRequired
Body
titlestring · max: 500Optional
contentstring · max: 100000Optional
meeting_datestring · date · nullableOptional
Responses
chevron-right
200

Entry updated

application/json
put
/v1/brands/{siteId}/notebook/{entryId}
200

Entry updated

Delete a notebook entry

delete
Authorizations
X-API-KEYstringRequired
Path parameters
siteIdstring · uuidRequired
entryIdstring · uuidRequired
Responses
delete
/v1/brands/{siteId}/notebook/{entryId}
204

Entry deleted

No content

Last updated

Was this helpful?