Preview JSON-LD

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns the Schema.org markup Base44 generates from the app's entities, so you can see it before publishing it.

Base44 matches each entity to the Schema.org type its fields look most like, and leaves out any entity it can't match with reasonable confidence, so an app whose entities are all app-specific returns an empty list.

Each entry's json_ld_template marks which entity field fills each property using a placeholder. For example, {"name": "{title}"} means name comes from this entity's title field.

There's no mechanism that fills in a placeholder for you. To use a field, edit json_ld_template yourself before saving it with Update SEO settings, replacing {title} with an actual value, for example {"name": "Acme CRM"} instead of {"name": "{title}"}. Base44 injects whatever you save exactly as written, on every page the entry applies to. There's no per-record substitution, so a hardcoded value shows up identically everywhere rather than varying by record.

Save the whole entry, including its json_ld_template key, as one of the objects in custom_json_ld with Update SEO settings. Saving alone isn't enough for the markup to appear on the page. See When JSON-LD markup goes live for what else has to be true.

Save confidence as a string, or leave it out. <Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

{
  "result": {
    "entities": [
      {
        "confidence": 0.85,
        "entity_name": "Product",
        "field_mapping": {
          "name": "title"
        },
        "json_ld_template": {
          "@context": "https://schema.org",
          "@type": "Product",
          "name": "{title}"
        },
        "schema_type": "Product"
      }
    ]
  }
}