Company

Get the company profile

What the classifier knows about you: name, description, use cases, your own accounts, and the composed context it reads.

get/v1/company

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/company
  • Auth: HTTP bearer

Response

The company profile

namestring required

Brand or company name, as the classifier should call it.

descriptionstring required

What the company does, one paragraph.

useCasesstring[] required

What people use the product for.

websitestring nullable required

The company website, as set up during onboarding.

competitorsstring[] required

Competitors by name, so the classifier reads a rival's mention as such; usually the same names as your competitor keywords.

guidelinesstring nullable required

Free-text rules for the classifier: what counts as relevant for you and what never does ("posts about our API, never job listings"). The second biggest lever after the description.

contextstring required

The text the classifier reads. Composed from the fields above unless you override it.

Changes

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