Source of truth for implementation is the canonical schema host: https://schemas.meta-aiml.org/v3.0.0/. If any page text conflicts with canonical schema files, follow canonical files. Documentation home.

Getting Started

META-AIML v3.0.0

Fastest correct path from zero to a valid v3 JSON-LD schema for your website.

Use canonical source files on https://schemas.meta-aiml.org/v3.0.0/.

1. Choose Entity Contract

Pick the closest entity type for your business.

Use the contract from canonical entity endpoints.

https://schemas.meta-aiml.org/v3.0.0/entity/<entity>.json

Open Entity Contracts

2. Start From Example

Take canonical example and replace with your business values.

Example endpoint pattern:

https://schemas.meta-aiml.org/v3.0.0/examples/<entity>_example_schema_v3.json

Open Examples

3. Validate

Validate in playground and SDK flow before publishing.

UI validator: /playground

SDK distribution: https://schemas.meta-aiml.org/v3.0.0/sdk/

Open Playground

4. Publish JSON-LD

Embed one canonical schema in website head.

Update schema manually when your business data changes.

For dynamic data (ratings/catalog), keep source links instead of stale snapshots.

Read Relationship Model

Minimal Valid Instance

Compact v3 instance with required core keys.

{
  "@context": ["https://schemas.meta-aiml.org/v3.0.0/context.jsonld"],
  "@id": "https://example.com/meta-aiml/web-app",
  "@type": "WebApp",
  "schemaVersion": "3.0.0",
  "aimlVersion": "3.0.0",
  "ontologicalMode": "DigitalEntity",
  "interactionArchetype": ["DirectService"],
  "domain": "Technology",
  "deliveryFormat": ["WebApp"],
  "name": { "en": "Acme Planner" },
  "description": {
    "en": "Acme Planner is a fictional task planning web application that provides collaborative workspaces and scheduling automation."
  },
  "url": "https://example.com",
  "modules": { "workspace": { "sharedBoards": true } },
  "capabilities": {
    "interaction": {
      "features": ["notifications", "comments"],
      "interactionMethods": ["online_form", "chat"],
      "availableActions": ["create_task", "assign_task", "share_workspace"]
    }
  },
  "structuralMetadata": {
    "topology": "binary",
    "roles": ["user", "platform"],
    "valueSource": "platform_provided",
    "transactionFlow": "direct",
    "networkEffects": "none"
  }
}

Embed in HTML

Put final JSON-LD into website <head>.

<script type="application/ld+json">
{
  "@context": ["https://schemas.meta-aiml.org/v3.0.0/context.jsonld"],
  "@id": "https://example.com/meta-aiml/web-app",
  "@type": "WebApp",
  "schemaVersion": "3.0.0",
  "aimlVersion": "3.0.0",
  "ontologicalMode": "DigitalEntity",
  "interactionArchetype": ["DirectService"],
  "domain": "Technology",
  "deliveryFormat": ["WebApp"],
  "name": { "en": "Acme Planner" },
  "description": { "en": "Acme Planner is a fictional task planning web application." },
  "modules": { "workspace": { "sharedBoards": true } },
  "capabilities": {
    "interaction": {
      "features": ["notifications", "comments"],
      "interactionMethods": ["online_form", "chat"],
      "availableActions": ["create_task", "assign_task", "share_workspace"]
    }
  },
  "structuralMetadata": {
    "topology": "binary",
    "roles": ["user", "platform"],
    "valueSource": "platform_provided",
    "transactionFlow": "direct",
    "networkEffects": "none"
  }
}
</script>

Checklist

schemaVersion and aimlVersion equal 3.0.0.

ontologicalMode and interactionArchetype are compatible.

Required fields from selected entity contract are present.

Validation in /playground passes without critical blockers.

Dynamic business data is represented via source links where needed.