LLllmpulse
Competitors

Add a competitor

Adds a competitor with its own citation URL matching rule. Honours the per-plan max competitors cap. Requires a read_write scope API key.

post/competitors

Request

  • Base URL
    https://api.llmpulse.ai/api/v1
  • Auth
    API key in header Authorization

Request body

project_idinteger required
brand_namestring required
domainstring required

URL is accepted and normalised to host (e.g. https://www.openai.com → openai.com)

matching_namesstring[]

Extra names this competitor is matched by; brand_name is added automatically. At most 50 names in all, brand_name included, of up to 100 characters each; a longer list or name is refused with ERR_INVALID_PARAM (422)

citation_match_mode'domain' | 'host' | 'path_prefix'

domain includes the registrable domain and all subdomains; host requires the exact hostname; path_prefix also requires citation_match_path

citation_match_pathstring

Required when citation_match_mode=path_prefix, e.g. /es. Case-sensitive; trailing slash is optional; query and fragment are ignored

Response

Created

project_idinteger required
competitors_remaininginteger nullable required

Competitors the plan still allows in this project; null when unlimited

total_competitorsinteger required
request_idstring required

Changes

No recorded changes to this operation across all 32 revisions of this API.