Example Payload Generator

Overview

You send a JSON Schema and we build one example document from it, the same way every time. Values come from the schema wherever it says something concrete — const, examples, default, enum — and fall back to a fixed placeholder per type otherwise, including sensible stand-ins for common string formats. We then check the result against your schema and tell you whether it passed, and we list every place a schema keyword chose the value. The output is a shape you can trust, not realistic-looking fake data.

Hand-written examples drift from the schema and a model-written one is a guess. You get a document derived from the contract itself, identical on every call.

When to use it

Scope

Non-goals

• We never invent realistic-looking or randomized fake data
• We never follow a $ref into another document or over the network
• We never check a payload you already have — that is schema.validate_json

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.generate_example_payload","input":{"schema":{"type":"object","properties":{"orderId":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string"}}}}},"required":["orderId"]},"mode":"complete","maxArrayItems":2}}'

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

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

const { output } = await sq.execute("schema.generate_example_payload", {"mode":"minimal","schema":{"required":["id"],"type":"object","properties":{"id":{"type":"string"}}}});

Errors

Other limits

Limitations

• We never invent realistic-looking or randomized fake data
• We never follow a $ref into another document or over the network
• We never check a payload you already have — that is schema.validate_json
• Producing believable test data with real-looking names, amounts, or dates
• Checking a payload you already have against a schema
• Schemas whose definitions live in another document

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "schema.generate_example_payload",
  "input": {
    "mode": "minimal",
    "schema": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}

Examples

{
  "mode": "minimal",
  "schema": {
    "required": [
      "id"
    ],
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      }
    }
  }
}

{
  "payload": {
    "id": "string"
  },
  "validAgainstSchema": true,
  "decisions": [],
  "warnings": []
}

{
  "schema": {
    "required": [
      "status",
      "contactEmail"
    ],
    "type": "object",
    "properties": {
      "status": {
        "type": "string",
        "enum": [
          "active",
          "pending",
          "suspended"
        ]
      },
      "contactEmail": {
        "type": "string",
        "format": "email"
      }
    }
  }
}

{
  "payload": {
    "status": "active",
    "contactEmail": "[email protected]"
  },
  "validAgainstSchema": true,
  "decisions": [
    {
      "rule": "enum",
      "path": "/status"
    }
  ],
  "warnings": []
}

Recommended use cases

• Fill the example section of your API docs with something that actually fits
• Seed a contract test or a mock endpoint straight from the schema
• Show an agent the exact shape it needs to produce before it starts filling values

Avoid for

• Producing believable test data with real-looking names, amounts, or dates
• Checking a payload you already have against a schema
• Schemas whose definitions live in another document

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