Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Required Fields Checker

schema.check_required_fields

ProductionBounded custom (Class B)Deterministicstrictfastv1.0.0
No network

Overview

You send a JSON payload plus the paths that must carry a value — as JSON Pointers, dotted paths, or a JSON Schema whose nested required lists we walk for you. We tell you whether the payload is complete and, for every gap, the exact path and why it counts as missing (absent, null, or empty_string). We look at presence only, never at types or formats, so use schema.validate_json when you need full conformance.

Rejected requests usually come down to one empty nested field, and a full schema validation run buries that answer in type noise. You get the gap list straight away.

Reliability

Deterministic: the same payload and the same required set always give you the same answer, and we never call out anywhere. Four things make us reject the call outright, none of them worth retrying unchanged: payload absent or not an object; requiredPaths present but not an array of strings; neither requiredPaths nor schema supplied; maxMissing outside 1 to 10000. Fix the input and call again.

Context footprint

Pure in-memory pointer lookups; the response is as small as your gap list, capped at maxMissing entries. A successful call costs 1 execution credit.

When to use it

Just before you submit a payload that a downstream system will reject if a mandatory field is blank.

When you also need types, formats, patterns, or enum membership verified — that is full schema validation.

Scope

Note
We answer one question: does every path you named actually carry a value? Presence only, across any nesting depth, with the reason for each gap.

Non-goals

  • We never check value types — reach for schema.validate_json
  • We never check enum membership — reach for schema.validate_enum_values
  • We never repair, fill in, or transform your payload

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

validation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input976.6 KB

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
payloadobjectYesJSON object to check for presence only; extra keys are payload fields and values may be nested objects, arrays, scalars or null. — unconstrained RFC 8259 JSON items.
requiredPathsarrayNoPaths that must carry a value, 1 through 10000 strings; omit it to derive paths from schema alone.
schemaobjectNoJSON Schema whose nested required arrays are turned into paths; omit it to check only requiredPaths. — unconstrained RFC 8259 JSON items.
treatNullAsMissingbooleanNoCount JSON null as a gap; omit it for true.
treatEmptyStringAsMissingbooleanNoCount an empty string as a gap; omit it for false.
maxMissingintegerNoHow many gaps to list, 1 through 10000; omit it for 1000.

Output schema

FieldTypeRequiredDescription
completebooleanYesTrue when every checked path carries a value.
missingarrayYesGaps in check order, 0 through 10000 closed {path, reason} objects; empty when complete.
checkedCountintegerYesHow many distinct paths were checked after merging and deduplicating.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.check_required_fields","input":{"payload":{"orderId":"SO-88120","shipTo":{"city":"Antwerp"}},"requiredPaths":["/orderId","/shipTo/city","/shipTo/postalCode"]}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

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

const { output } = await sq.execute("schema.check_required_fields", {"payload":{"user":{"name":"Alice Moreau"}},"requiredPaths":["/user/name","/user/email"]});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • We never check value types — reach for schema.validate_json
  • We never check enum membership — reach for schema.validate_enum_values
  • We never repair, fill in, or transform your payload
  • Full schema conformance, where types and formats matter (schema.validate_json)
  • Checking that a value is one of an allowed set (schema.validate_enum_values)
  • Comparing two payloads against each other

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "schema.check_required_fields",
  "input": {
    "payload": {
      "user": {
        "name": "Alice Moreau"
      }
    },
    "requiredPaths": [
      "/user/name",
      "/user/email"
    ]
  }
}

Examples

Signup payload is missing the email

Inputjson
{
  "payload": {
    "user": {
      "name": "Alice Moreau"
    }
  },
  "requiredPaths": [
    "/user/name",
    "/user/email"
  ]
}
Expected outputjson
{
  "missing": [
    {
      "reason": "absent",
      "path": "/user/email"
    }
  ],
  "complete": false,
  "checkedCount": 2
}

Invoice complete against a nested JSON Schema

Inputjson
{
  "payload": {
    "invoiceNumber": "INV-2026-0042",
    "customer": {
      "email": "[email protected]"
    }
  },
  "schema": {
    "required": [
      "invoiceNumber",
      "customer"
    ],
    "type": "object",
    "properties": {
      "customer": {
        "type": "object",
        "required": [
          "email"
        ]
      }
    }
  }
}
Expected outputjson
{
  "missing": [],
  "complete": true,
  "checkedCount": 3
}
  • Preflight a request body before you post it to a strict partner API
  • Confirm an agent-assembled payload carries every mandatory field
  • Tell a caller exactly which nested field is still empty, by pointer

Avoid for

  • Full schema conformance, where types and formats matter (schema.validate_json)
  • Checking that a value is one of an allowed set (schema.validate_enum_values)
  • Comparing two payloads against each other

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

schemavalidation