Check a payload without drawing it

POST /item-types/{type}:validate

Updated 8 Oct 20262 min read

POST/item-types/{type}:validateTry it

Basehttps://api.mockflow.com/v1

Request

curl https://api.mockflow.com/v1/item-types/artifact:validate \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
}'

const response = await fetch("https://api.mockflow.com/v1/item-types/artifact:validate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/item-types/artifact:validate",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
},
)

response.raise_for_status()
data = response.json()

Response

{
  "valid": false,
  "type": "artifact"
}

{
  "error": {
    "code": "validation_failed",
    "message": "data.columns[0].cards[0].priority must be one of low, medium, high",
    "details": [
      {
        "path": "data.columns[0].cards[0].priority",
        "expected": [
          "low",
          "medium",
          "high"
        ]
      }
    ]
  },
  "requestId": "req_01j9"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

Runs the same validation a create would, and answers 422 with the field that is wrong, or 200.

Authorization

Authorizationstringheaderrequired

Bearer <key>. Any key of the workspace. Create and manage keys in the developer console, or use an OAuth app to act for other people; what each scope unlocks is on the scopes page.

Path parameters

typeenum<string>pathrequired

Body

application/json

dataItemData

Selected by the sibling type. One schema per item type, generated from the component registry.

Response

200 · application/json

validboolean

typeenum<string>

Item types, generated from the MockFlow component registry. Primitive types are drawn by the editor; frame types are rich components whose data schema is the same one the MCP render_* tool accepts.

Errors

422validation_failed

The body did not match the schema for this item type.

429rate_limited

Too many requests.

Was this page helpful?