Company

Get the company profile

Returns what the classifier knows about your company. That is the name, description, use cases and your accounts, plus the context text built from them.

get/v1/company

Request

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

Response

Your company profile

namestring required

The name of your brand or company, as the classifier should use it.

descriptionstring required

A paragraph on what the company does.

useCasesstring[] required

Typical uses of the product.

websitestring nullable required

The company's website, as entered during onboarding.

competitorsstring[] required

Names of competitors, so the classifier knows when a post is about one of them. Often the same names as your competitor keywords.

guidelinesstring nullable required

Rules for the classifier in your own words, saying what is relevant to you and what never is, for example "questions about our SDK, never job ads". After the description, this has the most effect on scores.

contextstring required

Classifier input. Built from the other fields unless you write it yourself.

Changes

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