API Reference

Brands

Brands are the entities matched against platform answers: your own brand and any competitors you would like to track. Brand matches are what drive share of voice, sentiment, and citation tracking. Brands themselves are created by Pineprompt; only their classification is editable.

Endpoints

GET /api/v1/brands

List brands
Returns every brand belonging to the active project. The response is paginated.
POST /api/v1/brands

Create a brand
Creates a brand in the active project. Typically, Pineprompt discovers brands from AI responses on its own, so you should reach for this endpoint when you want to track a brand before it has appeared in a response. Segment membership is what makes a brand a competitor, so a brand created with segment_ids starts out tracked and one created without them starts out discovered. If you would like to designate a brand as the project's own brand, you may point the project's brand_id at it via the update-project endpoint.
GET /api/v1/brands/{brand}

Get a brand
Returns a single brand. The brand must belong to the active project.
PATCH /api/v1/brands/{brand}

Update a brand
Updates a brand's display name, aliases, domains, or ignored state. Every field is optional, so you may send only the fields you would like to change; a field that is omitted keeps its current value. A brand's kind is derived from its context and cannot be written directly: pass ignored to move the brand in or out of the ignored state, attach it to a segment to make it a competitor, or point the project's brand_id at it to make it the own brand. An ignored brand cannot sit in a segment, so ignoring one detaches it everywhere; ignoring the own brand returns a 422.