Accounts

Rank the competitors of one company

Required permissions: accounts:read.

Send one company ({ self: true } for your own workspace, or companyId / linkedinUrl / website / name) and get back a ranked roster, default 15 and at most 50. Rank 1 is your first pin when you send pins, else the category incumbent, else the closest match on product and buyer. Candidates are drawn from companies similar to the subject plus companies named while the roster is generated; each is judged direct, adjacent or not a competitor, with 0..100 product and ICP alignment.

The roster is stored per workspace and subject. A repeat call with the same pins and an equal or smaller cap returns the stored roster (reused: true) and does not generate a new one, so a changed positioning has no effect until you send refresh: true. Sending pins replaces the stored pins for that subject; a new roster is generated when the pin set changes. Sending pins stores them for the workspace under the same accounts:read scope. Synchronous. Generation typically takes 10 to 25 seconds. Allow more than 120 seconds for the client timeout.

post/v1/companies/competitors

Request

  • Base URL: https://api.trayo.ai
  • URL: https://api.trayo.ai/v1/companies/competitors
  • Auth: HTTP bearer

Request body

capinteger

Maximum roster length. Default 15, maximum 50.

positioningstring

What the subject sells and to whom. Defaults to the workspace's own positioning for { self: true }, else the company's public description. It is read only while a roster is being generated: a repeat call with the same pins and an equal or smaller cap returns the stored roster and ignores a changed positioning, so send refresh: true to apply one.

refreshboolean

Regenerate even when a stored roster with the same pins is available.

Response

capinteger required
generatedAtstring required

ISO 8601.

reusedboolean required

true when the stored roster was returned without generating a new one.

statsobject required

Changes

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