Embeds

Overview

The editor supports linking (embedding) between entities in your journal. Embed nodes appear in TipTap JSON content and reference other resources by type and ID.

Linkable entity types:

Embed node in TipTap JSON

Embed nodes appear in content JSON with a type and entity reference:

{
  "type": "embed",
  "attrs": {
    "entityType": "trade",
    "entityId": "uuid"
  }
}

Resolve embed references

Endpoint: POST /api/v1/embeds/resolve

Batch-check whether linked entities still exist for your account. Returns any references that are missing (deleted or inaccessible).

Request body

Example

curl -X POST "https://app.mypropjournal.com/api/v1/embeds/resolve" \
  -H "Authorization: Bearer mpj_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "refs": [
      { "type": "trade", "id": "uuid-1" },
      { "type": "playbook", "id": "uuid-2" }
    ]
  }'

Example response

{
  "data": {
    "missing": [
      { "type": "playbook", "id": "uuid-2" }
    ]
  }
}

Only references that no longer exist are returned in missing. An empty array means all references are valid.