OverviewAPI Reference
Company

Update the company profile

Changing profile fields recomposes the classifier context; setting `context` directly overrides it until the next profile edit. Relevance scores for new mentions follow at once.

PATCH
/v1/company

Authorization

AuthorizationBearer <token>

API key minted via POST /v1/api-keys (format mk_live_...)

In: header

Request Body

name?string
Length1 <= length <= 120
description?string
Lengthlength <= 1000
useCases?array<string>

Replaces the whole list.

Itemsitems <= 20
accounts?
website?string|null

The company website; null clears it.

Formaturi
Lengthlength <= 300
competitors?array<string>

Replaces the whole list; [] clears it.

Itemsitems <= 50
guidelines?string|null

Free-text rules for the classifier; null clears them.

Lengthlength <= 2000
context?string

Overrides the composed context until the next profile edit.

Lengthlength <= 4000

Response Body

application/json

application/json

application/json

curl -X PATCH "https://api.mentio.dev/v1/company" \  -H "Content-Type: application/json" \  -d '{}'
{
  "name": "string",
  "description": "string",
  "useCases": [
    "string"
  ],
  "accounts": {
    "x": "string",
    "linkedin": "string"
  },
  "website": "string",
  "competitors": [
    "string"
  ],
  "guidelines": "string",
  "context": "string"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Get the company profile GET

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

Create an API key POST

Mint a key for this workspace. The key itself is returned once; only its hash is stored. `expiresAt` makes it stop working at an instant (a key for a contractor or a one-off script); it stays listed until revoked.