Skip to main content
Projects represent brands you’re tracking in Topify.ai. Each project has its own set of prompts, competitors, and analytics data.

​
List projects

GET /api/v2/projects

List all projects for your team.
Query parameters:
ParamTypeDescription
user_idstring (UUID)Your user ID
pageintegerPage number (default: 1)
limitintegerResults per page (default: 20)
Response: Paginated list of projects with bootstrap status and settings.

​
Create project

POST /api/v2/projects

Create a new brand tracking project.
Request body:
FieldTypeRequiredDescription
brand_namestringYesBrand name to track
urlstringYesBrand website URL
countrystringNoTarget country
languagestringNoTarget language
team_idstring (UUID)YesYour team ID
user_idstring (UUID)YesYour user ID
Response: The created project object. After creating a project, call the bootstrap API to initialize it with AI analysis.

​
Get project

GET /api/v2/projects/:project_id

Get details for a specific project.
Response: Full project details including bootstrap status, settings, and brand aliases.

​
Update project

PUT /api/v2/projects/:project_id

Update project settings.
Request body: Any project fields you want to update (brand name, website, language, location).

​
Delete project

DELETE /api/v2/projects/:project_id

Delete a project and all its associated data.
This permanently deletes the project, all prompts, competitors, and collected data. This action cannot be undone.

​
Brand aliases

Brand aliases let you add alternative names for your brand. Topify.ai checks for all aliases when analyzing AI responses.
EndpointDescription
GET /api/v2/projects/:id/settings/aliasesList all aliases
POST /api/v2/projects/:id/settings/aliasesAdd a new alias
PATCH /api/v2/projects/:id/settings/aliasesUpdate an alias
DELETE /api/v2/projects/:id/settings/aliasesRemove an alias