apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Convert Markdown to JSON API

File Conversion#convert#json#markdown
ApyHub
ApyHub
verified icon
50 atoms
Base tier

About

This API lets you upload and transform Markdown data to JSON format.
This API is ideal for developers working on content management systems, static site generators, or any application where content is frequently converted from Markdown to a more structured format for further processing or display. It's particularly beneficial for projects requiring automated content analysis, content migration between platforms, or integration of Markdown content into data-driven applications, where JSON's structure can be easily utilized programmatically.
Try out the Markdown to JSON API in the API playground for free, improve your document workflow, and reduce JSON conversion errors with a simple API call.
Select API Endpoints
Input
Output

API Playground

This API endpoint does not have a playground yet. Please check back later.

API Documentation

upload file: download file
POST
https://api.apyhub.com/convert/md-file/json-file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/md-file/json-file?output=sample' \
2
--header 'apy-token: {{token}}' \
3
--form 'file=@"sample.md"'
Method: POST
Content Type: multipart/form-data
Request Body
AttributeTypeMandatoryDescription
fileFileYesThe source markdown(.md) file.
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe json file name for the converted data. If no output attribute is provided, the default file name will be sample-output.json

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Request is invalid.
401Required authentication information is either missing or not valid for the resource.
500There was an error in processing this request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles