tech/json-toolkit

API Reference

Format, Validate, and Convert JSON Instantly

JSONify API documentation interface displaying endpoint schemas and live request testing Explore Endpoints View Parameters

Core Endpoints

Interact with JSONify's processing engine via three dedicated REST routes. All requests require a valid Bearer token in the Authorization header and must be sent over HTTPS.

POST /format

Minifies or pretty-prints JSON payloads. Supports custom indentation (2, 4, or tab) and alphabetical key sorting. Returns a 200 OK with the transformed payload in the data field.

Rate Limit: 1,200 req/hr

POST /validate

Checks strict JSON syntax compliance against RFC 8259. Optionally validates against a user-supplied JSON Schema Draft 2020-12. Returns detailed error paths on failure.

Max Payload: 5 MB

POST /convert

Translates JSON to YAML, XML, or CSV. Automatically maps nested objects to dot-notation keys and handles type coercion for CSV exports.

Supports 12 output formats

Request Parameters

Configure endpoint behavior through query strings or JSON request bodies. All parameters are case-sensitive and must be URL-encoded when passed via query.

indent (string)

Controls whitespace in /format. Accepts 2, 4, tab, or none. Defaults to 2 if omitted. Invalid values trigger a 400 response.

schema (object)

Passed to /validate. Must conform to JSON Schema Draft 2020-12. Nested properties and required arrays are fully supported for deep validation.

target (string)

Required for /convert. Valid values: yaml, xml, csv. Returns 400 Bad Request if an unsupported format is specified or the payload exceeds nesting depth limits.

Response Schemas & Status Codes

All successful requests return a standardized JSON envelope. Errors follow RFC 7807 Problem Details conventions with actionable debugging pointers.

200 OK

Standard success envelope. Contains status: success, a UNIX millisecond timestamp, and a result object with the processed data. Average response size is 14 KB.

400 Bad Request

Returned when malformed JSON is submitted or required parameters are missing. Includes an errors array with line/column pointers and automated fix suggestions.

429 Too Many Requests

Triggered when the 1,200 req/hr limit is exceeded. Response body contains retry_after in seconds and a direct link to the rate limit dashboard.

Download OpenAPI Spec Contact Engineering