API Reference

Projects

A project represents a single brand or site you would like to monitor. Each project owns its own prompts, brands, monitors, and sources.

Endpoints

GET /api/v1/projects

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

Create a project
Creates a new project inside the active organization.
GET /api/v1/projects/{project}

Get a project
Returns a single project. The project must belong to the active organization.
DELETE /api/v1/projects/{project}

Delete a project
Deletes a project. The delete cascades to every monitor, prompt, tag, and segment the project owns. Its brands and sources are removed together with the project.
PATCH /api/v1/projects/{project}

Update a project
Updates a project. 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. Pass brand_id to designate the project's own brand, or null to leave the project without one.