JSON Schema Generator

Overview

JSON Schema Generator works by analyzing the structure and data types in sample JSON to produce a valid JSON Schema. It detects formats like date, email, and URI automatically and marks all fields as required.

Endpoint

One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.

curl -X POST https://api.apiverve.com/v1/jsonschemagenerator \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "json": {
    "name": "John Doe",
    "age": 30,
    "email": "john@example.com",
    "active": true
  },
  "title": "User Schema"
}'

const res = await fetch('https://api.apiverve.com/v1/jsonschemagenerator', {
  method: 'POST',
  headers: {
    'x-api-key': 'your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "json": {
    "name": "John Doe",
    "age": 30,
    "email": "john@example.com",
    "active": true
  },
  "title": "User Schema"
}),
});

if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);

const { data } = await res.json();
console.log(data);

import requests

res = requests.post(
    "https://api.apiverve.com/v1/jsonschemagenerator",
    headers={"x-api-key": "your_api_key_here"},
    json={
    "json": {
        "name": "John Doe",
        "age": 30,
        "email": "john@example.com",
        "active": True
    },
    "title": "User Schema"
},
    timeout=15,
)
res.raise_for_status()

print(res.json()["data"])

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "json": {
    "name": "John Doe",
    "age": 30,
    "email": "john@example.com",
    "active": true
  },
  "title": "User Schema"
}`)
	req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/jsonschemagenerator", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("x-api-key", "your_api_key_here")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.

Authentication

Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.

Parameters

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.

Response

Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.

{
  "status": "ok",
  "error": null,
  "data": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "User Schema",
    "type": "object",
    "properties": {
      "name": {
        "type": "string"
      },
      "age": {
        "type": "integer"
      },
      "email": {
        "type": "string",
        "format": "email"
      },
      "active": {
        "type": "boolean"
      }
    },
    "required": [
      "name",
      "age",
      "email",
      "active"
    ]
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.

Use cases

API Documentation

Generate JSON schemas for API request/response documentation automatically from sample data

Data Validation

Create validation schemas for JSON data in applications, APIs, or configuration files

Contract Testing

Generate schemas from API responses to use in contract testing and API monitoring

Code Generation

Use generated schemas as input for code generation tools to create type-safe data models

Other ways to use JSON Schema Generator

Set up JSON Schema Generator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.

Related

More in Data Generation: