CRM

Resolve descriptions for just-created records (cache-first)

postapi.modelmatch.com/v1/crm/records/describe-on-add

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

createdobject[]required

Show child attributes

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

Responses

200objectThe created entity ids that need a generate-description run (cache misses this caller claimed).

Show attributes

dataobjectrequired

Show child attributes

needsDescriptionEntityIdsstring[]required

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

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

curl -X POST "https://api.modelmatch.com/v1/crm/records/describe-on-add" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "created": [
      {
        "entityId": "<string>",
        "entityType": "lo"
      }
    ]
  }'

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

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

const { data, error } = await Crm.describeCrmRecordsOnAdd({
  body: {
    created: [
      {
        entityId: "<string>",
        entityType: "lo"
      }
    ]
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/describe-on-add",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "created": [
            {
                "entityId": "<string>",
                "entityType": "lo"
            }
        ]
    },
)
data = res.json()

200 response

{
  "data": {
    "needsDescriptionEntityIds": [
      "<string>"
    ]
  }
}