apyhub
DEVELOPER TOOLS · FILE CONVERSION

Convert JSON to YAML API

What it does

JSON to YAML Converter turns JSON into YAML from a raw request body, an uploaded JSON file, or a publicly accessible JSON URL. You can get the converted result as plain text, a downloadable .yaml file, or a pre-signed S3 URL depending on the endpoint you use.

Send a non-empty JSON object in the request body for raw conversion, or pass a file upload with application/json mimetype for file-based conversion. For URL-based conversion, provide a url that points to a JSON resource. The URL endpoints accept JSON served as application/json, text/plain, application/octet-stream, or binary/octet-stream, and also support URLs or paths that include .json.

Use JSON to YAML Converter when you need YAML for config files, deployment manifests, or handoff to systems that expect YAML instead of JSON. The outputs stay focused on the converted data, so you can plug them into downstream tooling without extra parsing steps.

▣ ENDPOINT 01 / 09
POST
Convert JSON from URL to YAML (S3 signed URL)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-url

QUICKSTART

GUIDE

Quickstart

Convert a JSON file from a public URL into a YAML download link.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/data.json"}'

What you'll get back

Returns a JSON object with a data string field — a pre-signed S3 URL for the converted file.

{
  "data": "https://..."
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Publicly accessible URL pointing to a JSON resource. The URL must return a content-type of application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include ".json".

About this endpoint

What it does

Converts JSON fetched from a publicly accessible URL into a YAML file and returns a pre-signed S3 URL where the converted file can be downloaded.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput name for the generated file. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a JSON resource. Must be a valid URI. The URL must return application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include .json.

Response

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted file. The success response is a JSON object with one top-level field: data (String).

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL to the converted file.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 02 / 09
POST
Convert raw JSON body to YAML (raw text)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-raw

QUICKSTART

GUIDE

Quickstart

Convert a JSON object to YAML by sending the JSON in the request body.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-raw" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"ApyHub","language":"json"}'

What you'll get back

Returns a JSON string containing the converted YAML content.

"name: ApyHub\nlanguage: json\n"
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.

About this endpoint

What it does

Converts a non-empty JSON object sent as the raw request body into YAML text. The response is returned as a raw string containing the YAML representation.

Request Body

ParameterTypeMandatoryDescription
bodyObjectYesAny non-empty JSON object. Sent as the request body with Content-Type: application/json. The body must not be empty. Additional properties are allowed.

Response

Returns a raw string containing the converted YAML output.

ParameterTypeMandatoryDescription
valueStringYesThe YAML document as raw text.

Body

Name
Type
Description
bodyREQUIRED
object
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.
▣ ENDPOINT 03 / 09
POST
Convert raw JSON body to YAML (downloadable file)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-file

QUICKSTART

GUIDE

Quickstart

Convert a JSON object to a downloadable YAML file by sending the JSON in the request body.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-file" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"ApyHub","version":1}'

What you'll get back

Returns a downloadable YAML file (.yaml) as binary data.

name: ApyHub
version: 1
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.

About this endpoint

What it does

Converts a raw JSON request body into a downloadable YAML file and returns the file as the response. The input must be a non-empty JSON object.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput filename or identifier. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
(root JSON object)ObjectYesAny non-empty JSON object. Sent as the request body with Content-Type: application/json. The body must not be empty. Additional properties are allowed.

Response

Returns a downloadable YAML (.yaml) file as binary content. The response schema is a single binary string representing the converted data.

ParameterTypeMandatoryDescription
binary fileStringYesYAML file content containing the converted data.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.
▣ ENDPOINT 04 / 09
POST
Convert raw JSON body to YAML (S3 signed URL)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-url

QUICKSTART

GUIDE

Quickstart

Convert a JSON object to YAML by sending your JSON payload to the endpoint.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-raw-yaml-url" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"sample"}'

What you'll get back

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted file.

{
  "data": "https://example-bucket.s3.amazonaws.com/converted.yaml"
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.

About this endpoint

What it does

Converts the raw JSON request body into a YAML file and returns a pre-signed S3 URL for the converted output. The request body must be a non-empty JSON object.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoDefault: sample-output

Request Body

ParameterTypeMandatoryDescription
bodyObjectYesAny non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty. Additional properties are allowed.

Response

Returns a JSON object with a data string field containing a URI. The data value is the pre-signed S3 URL to the converted file.

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL to the converted file.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
Any non-empty JSON object. Sent as the request body with Content-Type application/json. The body must not be empty.
▣ ENDPOINT 05 / 09
POST
Convert JSON from URL to YAML (raw text)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-raw

QUICKSTART

GUIDE

Quickstart

Convert a JSON file from a public URL into raw YAML by sending the file URL in the request body.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-raw" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/data.json"}'

What you'll get back

Returns a JSON string containing the converted YAML content.

"key: value\nname: Example\n"
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Publicly accessible URL pointing to a JSON resource. The URL must return a content-type of application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include ".json".

About this endpoint

What it does

Converts a JSON document fetched from a public URL into YAML and returns the YAML as raw text. The request body contains the source URL to retrieve; the response is a plain string containing the converted YAML.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a JSON resource. Must be a valid URI. The response content-type must be application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include .json.

Response

Returns a raw YAML string, not a JSON object. The success response body is a plain String.

ParameterTypeMandatoryDescription
valueStringYesThe converted YAML output returned as raw text.

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 06 / 09
POST
Convert JSON from URL to YAML (downloadable file)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-file

QUICKSTART

GUIDE

Quickstart

Convert a JSON file at a public URL into a downloadable YAML file.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-url-yaml-file" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/data.json"}'

What you'll get back

Returns a downloadable YAML file (.yaml) as binary data.

# binary file download
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Publicly accessible URL pointing to a JSON resource. The URL must return a content-type of application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include ".json".

About this endpoint

What it does

Converts JSON retrieved from a public URL into a downloadable YAML file. You submit the source URL in the request body, and the endpoint returns the converted .yaml file as binary output.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput file name prefix or identifier. Default: sample-output. Example: my-output.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a JSON resource. The URL must return a content-type of application/json, text/plain, application/octet-stream, or binary/octet-stream, or the Content-Disposition / URL path must include .json. Format: URI.

Response

Returns a downloadable YAML file as a binary response. The output schema is a single string value with binary format representing the converted .yaml file.

ParameterTypeMandatoryDescription
valueStringYesBinary YAML (.yaml) file containing the converted data.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 07 / 09
POST
Convert uploaded JSON file to YAML (raw text)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-raw

QUICKSTART

GUIDE

Quickstart

Upload a JSON file to convert it to raw YAML.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-raw" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.json"

What you'll get back

Returns a plain string containing the converted YAML.

key: value
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
JSON file to convert. The uploaded file must have mimetype application/json.

About this endpoint

What it does

Converts an uploaded JSON file into YAML and returns the converted YAML as raw text. The request accepts a JSON file upload, and the response is a plain string containing the YAML output.

Request Body

ParameterTypeMandatoryDescription
fileStringYesJSON file to convert. The uploaded file must have mimetype application/json.

Response

Returns a raw text response as a YAML string. The output schema is a plain string, so there is no JSON wrapper or named response field to extract.

Body

Name
Type
Description
bodyREQUIRED
object

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 08 / 09
POST
Convert uploaded JSON file to YAML (downloadable file)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-file

QUICKSTART

GUIDE

Quickstart

Upload a JSON file to convert it into a downloadable YAML file.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-file" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.json" \
  -F "output=my-output"

What you'll get back

Returns a downloadable YAML file (.yaml) as binary content.

# binary file download
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
JSON file to convert. The uploaded file must have mimetype application/json.

About this endpoint

What it does

Converts an uploaded JSON file into a downloadable YAML file. The request uploads a JSON file, and the response returns the converted YAML content as a binary file.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoDefault: sample-output

Request Body

ParameterTypeMandatoryDescription
fileStringYesBinary JSON file to convert. The uploaded file must have mimetype application/json.

Response

Returns a binary YAML file (.yaml) containing the converted data.

ParameterTypeMandatoryDescription
binary fileStringYesDownloadable YAML (.yaml) file containing the converted data.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 09 / 09
POST
Convert uploaded JSON file to YAML (S3 signed URL)
https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-url

QUICKSTART

GUIDE

Quickstart

Upload a JSON file to convert it into YAML.

curl -X POST "https://api.eu.apyverse.com/apyhub/convert-json-to-yaml/json-file-yaml-url" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/file.json"

What you'll get back

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted file.

{
  "data": "https://s3.amazonaws.com/..."
}
TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
JSON file to convert. The uploaded file must have mimetype application/json.

About this endpoint

What it does

Converts an uploaded JSON file into YAML and returns a pre-signed S3 URL for the converted file. The request sends the JSON file in the body, and the response contains the URL where the YAML output can be downloaded.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput name. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
fileStringYesJSON file to convert. Must be uploaded as binary and have mimetype application/json.

Response

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted file.

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL to the converted file.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.