Web Tools DocGuides

How to use API Mock Payload Builder

Get the best out of API Mock Payload Builder: every option explained, a worked example, and what to check when the output is not what you expected.

Updated August 1, 2026

What it does

Design simulated JSON schema response structures and export customizable mock API payloads locally. It runs entirely in your browser — your input never leaves your device.

Options

Every setting this tool exposes, straight from the code that validates it.

OptionTypeDefaultWhat it does
recordCountwhole number5How many records to generate. Accepts 1–1000. Defaults to 5.
fieldslist of object[{"name":"id","type":"uuid"},{"name":"name","type":"name"},{"name":"email","type":"email"},{"name":"isAdmin","type":"boolean"}]Defaults to [{"name":"id","type":"uuid"},{"name":"name","type":"name"},{"name":"email","type":"email"},{"name":"isAdmin","type":"boolean"}].

Worked example

Run these settings on the tool page:

  • recordCount: 5
  • fields: [{"name":"id","type":"uuid"},{"name":"name","type":"name"},{"name":"email","type":"email"},{"name":"isAdmin","type":"boolean"}]

You get:

[
  {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6100",
    "name": "Alice Smith",
    "email": "alice@example.com",
    "isAdmin": true
  },
  {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6101",
    "name": "Bob Jones",
    "email": "bob@example.com",
    "isAdmin": false
  },
  {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6102",
    "name": "Charlie Brown",
    "email": "charlie@example.com",
    "isAdmin": true
  },
  {
    "id": "f81d4fae-7dec-11d0-a765-00a0c91e6103",
    "name": "Diana Prince",
    "email": "diana@example.com",
    "isAdmin": false
  },
  {
    "id": "f81d4fae-7dec-11d0-a
… (truncated)

Getting the result you want

Most of the control here is in the options above. If the output is not what you expected, the setting to check first is recordCount and fields — those change the shape of the output rather than the input it accepts.

Troubleshooting

  • A value is rejected. recordCount accepts 1–1000. Anything outside that is refused rather than silently clamped.
  • It is slow on very large input. Everything runs in your browser, so speed depends on your device. Very large inputs are best split up, or run through the API where the work happens on our servers.

Automating it

The same logic is available as a REST endpoint, so you can run it from a script, a CI job or your own app.

Bash
curl "https://api.toolsxpo.com/v1/mock-payload-builder" \
  -H "Authorization: Bearer $TOOLSXPO_KEY"

It costs 1 credit per successful call. See the full endpoint reference, or try it in the playground.

Tools covered here

API Mock Payload Builder

API & Client-Side

api-client

Related