apyhub
DEVELOPER TOOLS · FILE CONVERSION

Convert YAML to JSON API

What it does

YAML to JSON Conversion turns YAML into JSON from a raw string, an uploaded file, or a publicly accessible URL. You can get the converted data back inline, as a downloadable JSON file, or as a pre-signed S3 URL depending on the endpoint you call.

Use it when your application accepts YAML configuration files and needs JSON for downstream services, storage, or browser-side processing. Send content for raw YAML, file for an uploaded YAML document, or url for a remote YAML file. The service returns either structured JSON, a binary JSON file, or an object containing a data URL to the converted file. For the URL-based outputs, you can also pass an output query value to name the generated file.

This is a practical fit for build tools, import pipelines, and internal admin utilities that need to normalize YAML without adding a parser to every client. If you are handling .yaml or .yml uploads, or converting config files fetched from storage, this service gives you a direct JSON representation with minimal plumbing.

▣ ENDPOINT 01 / 09
POST
Convert YAML at URL → S3 signed URL
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-url-json-url

QUICKSTART

GUIDE

Quickstart

Convert a YAML file from a public URL into a JSON file and get back a pre-signed download link.

curl -X POST "https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-url-json-url?output=my-converted-data" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://assets.apyhub.com/samples/sample.yaml"}'

What you'll get back

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

{
  "data": "https://s3.amazonaws.com/bucket/uuid_sample-output.json?..."
}
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 YAML file.

About this endpoint

What it does

Converts the YAML file at the provided public URL into JSON and returns a pre-signed S3 URL for the converted file. The request accepts the source YAML URL in the body and an optional output name in the query string.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput name used in the generated JSON filename. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a YAML file. Must be a URI.

Response

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted JSON file. The URL is valid for 5 minutes.

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL pointing to the converted JSON file. Must be a URI.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 02 / 09
POST
Convert uploaded YAML file → inline JSON
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-file-json-raw

QUICKSTART

GUIDE

Quickstart

Convert a YAML file to JSON by uploading it as multipart form data.

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

What you'll get back

Returns a JSON object or a JSON array, depending on the conversion result. The schema allows additional properties for objects, so the exact fields may vary.

{}
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*
YAML file to convert. Accepted MIME types: `application/x-yaml`, `text/yaml`, `text/x-yaml`, `application/octet-stream`, `binary/octet-stream`, `text/plain`. Files with `.yaml` or `.yml` extension are also accepted.

About this endpoint

What it does

Converts an uploaded YAML file into JSON and returns the converted result inline. The request accepts a binary file upload in the body, and the response shape can be either a JSON object or a JSON array.

Request Body

ParameterTypeMandatoryDescription
fileStringYesYAML file to convert. Accepted MIME types: application/x-yaml, text/yaml, text/x-yaml, application/octet-stream, binary/octet-stream, text/plain. Files with .yaml or .yml extension are also accepted.

Response

Returns the converted JSON inline as either a JSON object or a JSON array. The schema allows an object with additional properties, or an array whose item schema is not further specified.

ParameterTypeMandatoryDescription
object responseObjectNoA JSON object response with additional properties allowed.
array responseArrayNoA JSON array response; item shape is not defined in the schema.

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 03 / 09
POST
Convert uploaded YAML file → S3 signed URL
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-file-json-url

QUICKSTART

GUIDE

Quickstart

Upload a YAML file and get back a pre-signed URL for the converted JSON file.

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

What you'll get back

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

{
  "data": "https://s3.amazonaws.com/bucket/uuid_sample-output.json?..."
}
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*
YAML file to convert. Accepted MIME types: `application/x-yaml`, `text/yaml`, `text/x-yaml`, `application/octet-stream`, `binary/octet-stream`, `text/plain`. Files with `.yaml` or `.yml` extension are also accepted.

About this endpoint

What it does

Converts an uploaded YAML file into JSON and returns a pre-signed S3 URL for the generated JSON file. The response contains the URL only; the converted file is retrieved from that URL.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput file name base used in the generated JSON object key. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
fileStringYesYAML file to convert. Accepted MIME types: application/x-yaml, text/yaml, text/x-yaml, application/octet-stream, binary/octet-stream, text/plain. Files with .yaml or .yml extension are also accepted.

Response

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted JSON file. The URL is valid for 5 minutes.

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL pointing to the converted JSON file (valid for 5 minutes).

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 04 / 09
POST
Convert raw YAML body → inline JSON
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-raw-json-raw

QUICKSTART

GUIDE

Quickstart

Convert a raw YAML string to JSON with one request.

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

What you'll get back

Returns a JSON object or array, depending on the input. The output schema allows either a JSON object with arbitrary top-level fields or a JSON array of arbitrary items.

{
  "name": "Alice",
  "age": 30
}
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*
Raw YAML string to convert.

About this endpoint

What it does

Converts a raw YAML string in the request body into JSON. The response is a JSON value that can be either an object or an array, depending on the YAML content.

Request Body

ParameterTypeMandatoryDescription
contentStringYesRaw YAML string to convert.

Response

Returns either a JSON object with arbitrary top-level properties or a JSON array, depending on the YAML input. The success response is not more specific than that in the schema.

ParameterTypeMandatoryDescription
object responseObjectNoA JSON object with additional top-level properties allowed.
array responseArrayNoA JSON array whose item schema is not defined.

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 05 / 09
POST
Convert raw YAML body → S3 signed URL
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-raw-json-url

QUICKSTART

GUIDE

Quickstart

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

curl -X POST "https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-raw-json-url?output=my-converted-data" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"name: Alice\nage: 30"}'

What you'll get back

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

{
  "data": "https://s3.amazonaws.com/bucket/uuid_sample-output.json?..."
}
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*
Raw YAML string to convert.

About this endpoint

What it does

Converts a raw YAML string in the request body into JSON and returns a pre-signed S3 URL where the converted JSON file can be downloaded. The output query parameter controls the output filename stem used for the generated file.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoOutput filename stem. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
contentStringYesRaw YAML string to convert.

Response

Returns a JSON object with a data string field containing a pre-signed S3 URL to the converted JSON file. The URL is valid for 5 minutes.

ParameterTypeMandatoryDescription
dataStringYesPre-signed S3 URL pointing to the converted JSON file. Valid for 5 minutes.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 06 / 09
POST
Convert YAML at URL → inline JSON
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-url-json-raw

QUICKSTART

GUIDE

Quickstart

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

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

What you'll get back

Returns a JSON object or a JSON array, depending on the conversion result. The schema allows additional top-level fields if the response is an object.

{}
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 YAML file.

About this endpoint

What it does

Converts the YAML file found at the provided URL into JSON and returns the converted content inline. The request takes a URL to a publicly accessible YAML file and the response is the parsed JSON value, which may be either an object or an array.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a YAML file. Must be a valid URI.

Response

Returns inline JSON on success. The response is a JSON value that can be either an object with additional properties or an array.

ParameterTypeMandatoryDescription
objectObjectNoReturned when the converted YAML content is a JSON object. The schema allows additional properties.
arrayArrayNoReturned when the converted YAML content is a JSON array. The array items are not further constrained by the schema.

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 07 / 09
POST
Convert YAML at URL → downloadable JSON file
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-url-json-file

QUICKSTART

GUIDE

Quickstart

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

curl -X POST "https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-url-json-file?output=my-converted-data" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://assets.apyhub.com/samples/sample.yaml"}'

What you'll get back

Returns a downloadable JSON file as a binary response containing the converted data.

<binary JSON file>
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 YAML file.

About this endpoint

What it does

Converts the YAML file available at a publicly accessible URL into a downloadable JSON file.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoName for the generated file without extension. Default: sample-output.

Request Body

ParameterTypeMandatoryDescription
urlStringYesPublicly accessible URL pointing to a YAML file. Format: URI.

Response

Returns a binary file response containing the converted JSON data as a downloadable file. The output schema is a string with binary format, so the success response is the file content rather than a JSON object.

ParameterTypeMandatoryDescription
binary fileStringYesDownloadable JSON file containing the converted data.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ ENDPOINT 08 / 09
POST
Convert uploaded YAML file → downloadable JSON file
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-file-json-file

QUICKSTART

GUIDE

Quickstart

Convert a YAML file to a JSON file by uploading it as multipart form data.

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

What you'll get back

Returns a downloadable JSON file as a binary response containing the converted data.

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*
YAML file to convert. Accepted MIME types: `application/x-yaml`, `text/yaml`, `text/x-yaml`, `application/octet-stream`, `binary/octet-stream`, `text/plain`. Files with `.yaml` or `.yml` extension are also accepted.

About this endpoint

What it does

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

Query Parameter(s)

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

Request Body

ParameterTypeMandatoryDescription
fileStringYesYAML file to convert. Accepted MIME types: application/x-yaml, text/yaml, text/x-yaml, application/octet-stream, binary/octet-stream, text/plain. Files with .yaml or .yml extension are also accepted.

Response

Returns a downloadable JSON file as a binary response containing the converted data.

ParameterTypeMandatoryDescription
Response bodyStringYesDownloadable JSON 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 raw YAML body → downloadable JSON file
https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-raw-json-file

QUICKSTART

GUIDE

Quickstart

Convert raw YAML into a downloadable JSON file.

curl -X POST "https://api.eu.apyverse.com/apyhub/yaml-to-json-conversion/yaml-raw-json-file?output=sample-output" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"name: Alice\nage: 30"}'

What you'll get back

Returns a binary JSON file download containing the converted data.

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*
Raw YAML string to convert.

About this endpoint

What it does

Converts a raw YAML string sent in the request body into a downloadable JSON file. The endpoint returns the converted data as a binary file response.

Query Parameter(s)

AttributeTypeMandatoryDescription
outputStringNoDefault: sample-output. String value used as a query parameter.

Request Body

ParameterTypeMandatoryDescription
contentStringYesRaw YAML string to convert.

Response

Returns a downloadable JSON file as a binary response.

ParameterTypeMandatoryDescription
binaryStringYesThe response body is a binary file containing the converted JSON data.

Query parameters

Name
Type
Description
outputOPTIONAL
string
DEFAULT sample-output

Body

Name
Type
Description
bodyREQUIRED
object
▣ 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.