API documentation
Every payloadly tool is available as a REST endpoint. The interface is deliberately boring: POST your document as plain text, get the converted document back as plain text. Errors come back as JSON with a descriptive message. Call it from your own code, or drop it into a no-code automation as an HTTP step (see below).
Authentication
Anonymous requests get 25 calls per day. With an API key (issued instantly when you subscribe), requests are unlimited. Pass the key in the X-Api-Key header.
Convert a document
curl -X POST https://payloadly.com/api/v1/tools/json-to-csv \ -H "Content-Type: text/plain" \ -H "X-Api-Key: pl_live_..." \ --data-binary @data.json
Tools that take an option (for example the CSV column extractor, or the JSON formatter's indent) accept it as a query parameter:
curl -X POST "https://payloadly.com/api/v1/tools/csv-column-extractor?option=name,level" \ -H "Content-Type: text/plain" \ --data-binary @data.csv
Use it in a no-code automation
Because every tool is a plain HTTP endpoint, you can call it from Zapier, Make, n8n, or any workflow tool that has an HTTP request step, no code required. Configure the step like this:
- Method:
POST - URL:
https://payloadly.com/api/v1/tools/<tool-slug>(for examplejson-to-csv; every slug is in the table below) - Header:
X-Api-Key: your_key - Header:
Content-Type: text/plain - Body: the document to convert as raw text, or map a field from a previous step
The response body is the converted document, ready to map straight into the next step of your workflow. If you send an option, add it to the URL as a ?option= query parameter.
Responses
200: converted document, plain text, correct MIME type.422: input could not be parsed; JSON body explains why, with line numbers where available.429: anonymous daily limit reached.401: invalid or deactivated API key.413: body over 4 MB.
Endpoints
| Endpoint | Input | Output |
|---|---|---|
| /api/v1/tools/json-to-csv | JSON | CSV |
| /api/v1/tools/csv-to-json | CSV | JSON |
| /api/v1/tools/json-to-yaml | JSON | YAML |
| /api/v1/tools/yaml-to-json | YAML | JSON |
| /api/v1/tools/json-to-toml | JSON | TOML |
| /api/v1/tools/toml-to-json | TOML | JSON |
| /api/v1/tools/yaml-to-toml | YAML | TOML |
| /api/v1/tools/toml-to-yaml | TOML | YAML |
| /api/v1/tools/json-to-xml | JSON | XML |
| /api/v1/tools/xml-to-json | XML | JSON |
| /api/v1/tools/csv-to-tsv | CSV | TSV |
| /api/v1/tools/tsv-to-csv | TSV | CSV |
| /api/v1/tools/json-formatter | JSON | JSON |
| /api/v1/tools/json-minifier | JSON | JSON |
| /api/v1/tools/yaml-formatter | YAML | YAML |
| /api/v1/tools/xml-formatter | XML | XML |
| /api/v1/tools/json-validator | JSON | Text |
| /api/v1/tools/yaml-validator | YAML | Text |
| /api/v1/tools/toml-validator | TOML | Text |
| /api/v1/tools/xml-validator | XML | Text |
| /api/v1/tools/jwt-decoder | JWT | JSON |
| /api/v1/tools/json-flattener | JSON | JSON |
| /api/v1/tools/json-schema-generator | JSON | JSON |
| /api/v1/tools/csv-column-extractor | CSV | CSV |
| /api/v1/tools/base64-encoder | Text | Base64 |
| /api/v1/tools/base64-decoder | Base64 | Text |