API v1

Create project

Create a project. Provide a URL (we scrape to build a profile), or name + context (you describe your product). Optionally include competitor URLs to kick off analysis immediately.

post/api/v1/projects

Request

  • Base URL: https://api.rivalize.ai
  • URL: https://api.rivalize.ai/api/v1/projects
  • Auth: HTTP bearer

Request body

urlstring

Your product URL

namestring

Your product name

contextstring

Product description, ICP, differentiators — used as the lens for analysis

competitorsstring[]

Competitor URLs to analyze. The number accepted is capped by your plan; exceeding it returns 409 COMPETITOR_LIMIT_REACHED.

Response

Default Response

dataobject

Changes

No recorded changes to this operation across all 1 revision of this API.