{"from":"yaml","to":"json","result":"{\n \"name\": \"Ana\",\n \"roles\": [\n \"admin\",\n \"editor\"\n ],\n \"active\": true\n}"}
curl --location --request POST 'https://zylalabs.com/api/13173/structured+data+format+converter+api/26719/convert+a+document' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw 'name: Ana
roles:
- admin
- editor
active: true'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Structured Data Format Converter API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Trusted by leading companies
One endpoint to translate between the four common structured text formats. Send the content as the request body, choose the source and target formats, and receive the converted document.
Useful for migrating configuration files between formats, talking to legacy systems, exporting data for spreadsheet users, and normalizing mixed format feeds.
The Convert a Document endpoint allows users to convert structured text data between four formats: JSON, YAML, XML, and CSV. This is useful for migrating configuration files, integrating with legacy systems, and normalizing mixed format feeds.
The endpoint accepts parameters such as "from" to specify the source format and "to" to indicate the target format. Users must provide the data in the request body for conversion.
The response data is structured as a JSON object containing three key fields: "from" (source format), "to" (target format), and "result" (the converted document). This structure allows users to easily identify the conversion details.
Accepted parameter values for the "from" and "to" fields include "json," "yaml," "xml," and "csv." Users must ensure they select valid formats for successful conversions.
The returned data is in JSON format, with the "result" field containing the converted document as a string. For example, converting YAML to JSON will yield a JSON object representing the original data structure.
Typical use cases include migrating configuration files between formats, exporting data for spreadsheet users, and integrating data from mixed format feeds into a unified structure for processing.
Users can parse the "result" field to access the converted document. This allows for further processing, storage, or integration into applications, depending on the target format selected.
The API employs deterministic algorithms to ensure consistent output across conversions. This minimizes discrepancies and maintains data integrity, making it suitable for delivery jobs and data pipelines.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund