Required Fields Checker
schema.check_required_fields
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
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
Capabilities
Cost & billing
Flat rate per invocation
File handling
How we handle your data
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.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| payload | object | Yes | JSON 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. |
| requiredPaths | array | No | Paths that must carry a value, 1 through 10000 strings; omit it to derive paths from schema alone. |
| schema | object | No | JSON Schema whose nested required arrays are turned into paths; omit it to check only requiredPaths. — unconstrained RFC 8259 JSON items. |
| treatNullAsMissing | boolean | No | Count JSON null as a gap; omit it for true. |
| treatEmptyStringAsMissing | boolean | No | Count an empty string as a gap; omit it for false. |
| maxMissing | integer | No | How many gaps to list, 1 through 10000; omit it for 1000. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| complete | boolean | Yes | True when every checked path carries a value. |
| missing | array | Yes | Gaps in check order, 0 through 10000 closed {path, reason} objects; empty when complete. |
| checkedCount | integer | Yes | How many distinct paths were checked after merging and deduplicating. |
API contract
POST /v1/executecurl -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"]}}'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
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 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)
{
"skillKey": "schema.check_required_fields",
"input": {
"payload": {
"user": {
"name": "Alice Moreau"
}
},
"requiredPaths": [
"/user/name",
"/user/email"
]
}
}Examples
Signup payload is missing the email
{
"payload": {
"user": {
"name": "Alice Moreau"
}
},
"requiredPaths": [
"/user/name",
"/user/email"
]
}{
"missing": [
{
"reason": "absent",
"path": "/user/email"
}
],
"complete": false,
"checkedCount": 2
}Invoice complete against a nested JSON Schema
{
"payload": {
"invoiceNumber": "INV-2026-0042",
"customer": {
"email": "[email protected]"
}
},
"schema": {
"required": [
"invoiceNumber",
"customer"
],
"type": "object",
"properties": {
"customer": {
"type": "object",
"required": [
"email"
]
}
}
}
}{
"missing": [],
"complete": true,
"checkedCount": 3
}Recommended use cases
- 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
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.