Get the block schema

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-blockschema-get"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/e78e5539-f768-4ebe-8ecc-b74aee6d7986/social-card.svg?v=3e7ae33eec8b" alt="Get the block schema" width="600" height="315"></a>
GEThttps://forumulate.com/api/docs/block-schema

The block model, described by itself: every node type, the attributes each takes and their accepted values, the marks, and under hooks the anchor/className/hook every node also takes. Derived from the validator, so it is what a write will accept.

Parameters
forumulate-versionstringheader
API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:
Code samples
cURL
curl -X GET "https://forumulate.com/api/docs/block-schema" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/docs/block-schema', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/docs/block-schema",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/docs/block-schema", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/docs/block-schema');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/docs/block-schema')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/docs/block-schema"))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "hooks": [
    {
      "accepts": [
        "string"
      ],
      "description": "string",
      "glyphs": [
        "string"
      ],
      "max": 0,
      "min": 0,
      "name": "string",
      "properties": [
        {
          "accepts": null,
          "description": null,
          "glyphs": null,
          "max": null,
          "min": null,
          "name": null,
          "properties": null,
          "required": null,
          "type": null,
          "values": null
        }
      ],
      "required": true,
      "type": "string",
      "values": [
        null
      ]
    }
  ],
  "inline": [
    {
      "attrs": [
        {
          "accepts": null,
          "description": null,
          "glyphs": null,
          "max": null,
          "min": null,
          "name": null,
          "properties": null,
          "required": null,
          "type": null,
          "values": null
        }
      ],
      "content": "blocks",
      "contentRequired": true,
      "type": "string"
    }
  ],
  "markdownDialect": {
    "guide": "string",
    "href": "string"
  },
  "marks": [
    {
      "attrs": [
        {
          "accepts": null,
          "description": null,
          "glyphs": null,
          "max": null,
          "min": null,
          "name": null,
          "properties": null,
          "required": null,
          "type": null,
          "values": null
        }
      ],
      "type": "string"
    }
  ],
  "nodes": [
    {
      "attrs": [
        {
          "accepts": null,
          "description": null,
          "glyphs": null,
          "max": null,
          "min": null,
          "name": null,
          "properties": null,
          "required": null,
          "type": null,
          "values": null
        }
      ],
      "content": "blocks",
      "contentRequired": true,
      "directive": "string",
      "type": "string"
    }
  ],
  "root": {
    "attrs": [
      {
        "accepts": [
          null
        ],
        "description": "string",
        "glyphs": [
          null
        ],
        "max": 0,
        "min": 0,
        "name": "string",
        "properties": [
          null
        ],
        "required": true,
        "type": "string",
        "values": [
          null
        ]
      }
    ],
    "content": "blocks",
    "contentRequired": true,
    "type": "string"
  }
}
Schema
hooksBlockAttrSpec[]required
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
inlineBlockNodeSpec[]required
Show child parameters
attrsBlockAttrSpec[]required
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
contentstringrequired
blocks | inline | none
contentRequiredbooleanrequired
typestringrequired
markdownDialectobjectrequired
Show child parameters
guidestringrequired
hrefstringrequired
marksMarkSpec[]required
Show child parameters
attrsBlockAttrSpec[]required
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
typestringrequired
nodesobject[]required
Show child parameters
attrsBlockAttrSpec[]required
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
contentstringrequired
blocks | inline | none
contentRequiredbooleanrequired
directivestringrequired
typestringrequired
rootobjectrequired
Show child parameters
attrsBlockAttrSpec[]required
Show child parameters
acceptsstring[]
descriptionstring
glyphsstring[]
maxnumber
minnumber
namestringrequired
propertiesBlockAttrSpec[]
requiredbooleanrequired
typestringrequired
valuesstring | number[]
contentstringrequired
blocks | inline | none
contentRequiredbooleanrequired
typestringrequired
400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
429 Rate limited — see the RateLimit-* headers.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
default Error — the stable { error: { code, message } } envelope.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
The Forumulate teamUpdated