CRM

Auto-generate a record's description from the web

postapi.modelmatch.com/v1/crm/records/generate-description

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

companystring

Ignored.

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

locationstring

Ignored.

namestring

Ignored. Who is researched comes from the market-data record, not the request.

titlestring

Ignored.

Responses

200objectThe generated description, or null when no usable source was found.

Show attributes

dataobjectrequired

Show child attributes

descriptionstring | nullrequired

sourcesobject[]

Web pages the description was built from (http/https, at most 8). Empty when no description was produced.

Show child attributes

hrefstringrequired

titlestringrequired

statusenum

cached = a description was produced; no_match = researched but nothing reliably matched this record; none = the research run failed and can be retried.

Options:cachedno_matchnone

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

429object`rate_limited` — too many AI requests from this user in the last minute. Wait `retryAfterSeconds` (also sent as the `Retry-After` header).

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/crm/records/generate-description" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo",
    "company": "<string>",
    "location": "<string>",
    "name": "<string>",
    "title": "<string>"
  }'

import { createClient, Crm } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Crm.generateCrmRecordDescription({
  body: {
    entityId: "<string>",
    entityType: "lo",
    company: "<string>",
    location: "<string>",
    name: "<string>",
    title: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/generate-description",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "entityType": "lo",
        "company": "<string>",
        "location": "<string>",
        "name": "<string>",
        "title": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "description": "<string>",
    "sources": [
      {
        "href": "<string>",
        "title": "<string>"
      }
    ],
    "status": "cached"
  }
}