Compare Payload to Schema

Overview

You send a JSON payload and the JSON Schema it was supposed to match. We validate it and turn every deviation into a classified finding — missing required field, type mismatch, enum mismatch, unexpected field, format violation, or other constraint violation — each with a JSON Pointer, the schema keyword that failed, and a severity. You also get counts per category so you can tell a one-field typo from a broken contract. To compare two schemas with each other, use schema.diff_json_schema instead.

A plain validation verdict tells you something broke but not what changed. You get the shape of the drift: which paths, which keywords, how severe, how many.

When to use it

Scope

Non-goals

• We never repair or reshape your payload — you decide what to change
• We never fetch a schema for you; send it inline with the request
• We never compare two schemas with each other

Properties

Capabilities

Cost & billing

Flat rate per invocation

File handling

How we handle your data

Input schema

Output schema

API contract

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.compare_payload_to_schema","input":{"payload":{"customerId":"8842"},"schema":{"type":"object","properties":{"customerId":{"type":"integer"}},"required":["customerId"]},"draft":"2020-12","mode":"strict","maxFindings":50}}'

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("schema.compare_payload_to_schema", {"payload":{"email":"[email protected]","customerId":"8842"},"schema":{"properties":{"email":{"type":"string"},"customerId":{"type":"integer"}},"type":"object","required":["customerId","email"]}});

Errors

Other limits

Limitations

• We never repair or reshape your payload — you decide what to change
• We never fetch a schema for you; send it inline with the request
• We never compare two schemas with each other
• Comparing two schema versions with each other (schema.diff_json_schema)
• A plain pass or fail answer with no classification (schema.validate_json)
• Checking presence of mandatory fields only (schema.check_required_fields)

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "schema.compare_payload_to_schema",
  "input": {
    "payload": {
      "email": "[email protected]",
      "customerId": "8842"
    },
    "schema": {
      "properties": {
        "email": {
          "type": "string"
        },
        "customerId": {
          "type": "integer"
        }
      },
      "type": "object",
      "required": [
        "customerId",
        "email"
      ]
    }
  }
}

Examples

{
  "payload": {
    "email": "[email protected]",
    "customerId": "8842"
  },
  "schema": {
    "properties": {
      "email": {
        "type": "string"
      },
      "customerId": {
        "type": "integer"
      }
    },
    "type": "object",
    "required": [
      "customerId",
      "email"
    ]
  }
}

{
  "valid": false,
  "summary": {
    "constraintViolations": 0,
    "total": 1,
    "missingRequired": 0,
    "unexpectedFields": 0,
    "typeMismatches": 1,
    "enumMismatches": 0
  },
  "findings": [
    {
      "keyword": "type",
      "path": "/customerId",
      "type": "TYPE_MISMATCH",
      "severity": "breaking",
      "message": "string found, integer expected"
    }
  ],
  "driftDetected": true
}

{
  "schema": {
    "properties": {
      "email": {
        "type": "string"
      },
      "customerId": {
        "type": "integer"
      }
    },
    "type": "object",
    "required": [
      "customerId",
      "email"
    ]
  },
  "mode": "strict",
  "payload": {
    "email": "[email protected]",
    "customerId": 8842
  }
}

{
  "valid": true,
  "summary": {
    "constraintViolations": 0,
    "total": 0,
    "missingRequired": 0,
    "unexpectedFields": 0,
    "typeMismatches": 0,
    "enumMismatches": 0
  },
  "findings": [],
  "driftDetected": false
}

Recommended use cases

• Find out which fields drifted after a partner changed their API response
• Explain to a caller why their request body was rejected, field by field
• Compare what a producer emits against what a consumer expects to receive

Avoid for

• Comparing two schema versions with each other (schema.diff_json_schema)
• A plain pass or fail answer with no classification (schema.validate_json)
• Checking presence of mandatory fields only (schema.check_required_fields)

Related skills

Composable with

Safety & privacy

• Runs without calling any external service.
• Your payloads are never stored permanently.
• Telemetry captures metadata only — never your payload contents.
• We never train models on your payloads.
• No human reviews your payloads.

Tags