json-to-yaml

Convert a JSON file to YAML format. Produces human-readable block-style YAML with original key order preserved.

Endpoint

POST /v1/convert/json-to-yaml

Content-Type: multipart/form-data

Accepted input: .json files (UTF-8 encoded)

Output format: .yaml (application/x-yaml)

Authentication

Requires either a private API key or a JWT token from a public key.

X-API-Key: sk_live_your_private_key

Or:

Authorization: Bearer <jwt_token>

Request Parameters

Parameter	Type	Required	Default	Description
`file`	file	Yes	--	The `.json` file to convert. Must be UTF-8 encoded.
`output_filename`	`string`	No	Input filename	Custom output filename. The `.yaml` extension is added automatically.
`direct_download`	`boolean`	No	`true`	When `true`, returns raw YAML bytes. When `false`, returns metadata with a presigned download URL.

Conversion Rules

Direct mapping from JSON to YAML with no restructuring:

{
  "database": {
    "host": "localhost",
    "port": 5432,
    "credentials": {
      "user": "admin",
      "password": "secret"
    }
  },
  "features": ["auth", "logging"]
}

Becomes:

database:
  host: localhost
  port: 5432
  credentials:
    user: admin
    password: secret
features:
- auth
- logging

Output uses block style (multi-line, human-readable), not flow style
Key order is preserved from the original JSON
Unicode characters are preserved as-is

Response

Direct Download (`direct_download=true`, default)

HTTP 200 OK
Content-Type: application/x-yaml
Content-Disposition: inline; filename="config_20260405_123456789.yaml"

Metadata Response (`direct_download=false`)

{
    "presigned_url": "https://spaces.example.com/...",
    "object_key": "env/files/{project_id}/json-to-yaml/config_20260405_123456789.yaml",
    "filename": "config_20260405_123456789.yaml",
    "file_size": 1234,
    "conversion_time_seconds": 0.03
}

Code Examples

Python

import requests

with open("config.json", "rb") as f:
    response = requests.post(
        "https://api.enconvert.com/v1/convert/json-to-yaml",
        headers={"X-API-Key": "sk_live_your_private_key"},
        files={"file": ("config.json", f, "application/json")}
    )

with open("config.yaml", "wb") as out:
    out.write(response.content)

Node.js

const form = new FormData();
form.append("file", fs.createReadStream("config.json"));

const response = await fetch("https://api.enconvert.com/v1/convert/json-to-yaml", {
    method: "POST",
    headers: { "X-API-Key": "sk_live_your_private_key" },
    body: form
});

const yaml = await response.text();

PHP

$ch = curl_init("https://api.enconvert.com/v1/convert/json-to-yaml");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: sk_live_your_private_key"],
    CURLOPT_POSTFIELDS => ["file" => new CURLFile("config.json", "application/json")]
]);
$yaml = curl_exec($ch);
curl_close($ch);

Go

body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("file", "config.json")
file, _ := os.Open("config.json")
io.Copy(part, file)
writer.Close()

req, _ := http.NewRequest("POST", "https://api.enconvert.com/v1/convert/json-to-yaml", body)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("X-API-Key", "sk_live_your_private_key")
resp, _ := http.DefaultClient.Do(req)

Error Responses

Status	Condition
`400 Bad Request`	File is not a `.json` file
`400 Bad Request`	Invalid JSON content
`400 Bad Request`	JSON to YAML conversion failed
`401 Unauthorized`	Missing or invalid API key / JWT token
`402 Payment Required`	Monthly conversion limit reached
`413 Payload Too Large`	File exceeds plan's maximum file size

Limits

Limit	Value
Max file size	Plan-dependent (Free: 5 MB)
Input encoding	UTF-8 only
Monthly conversions	Plan-dependent

API Documentation Beta