{
"markdown": "| name | score |\n| --- | --- |\n| Ada | 42 |",
"format": "csv",
"filename": "test.csv",
"inputBytes": 18,
"outputBytes": 44,
"ocrUsed": false
}
curl --location --request POST 'https://zylalabs.com/api/14918/office+document+to+markdown+api/38828/convert+document+to+markdown' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{"filename":"test.csv","contentBase64":"bmFtZSxzY29yZQpBZGEsNDIK"}'
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 Office Document to Markdown 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.
Convert office documents, HTML, UTF-8 text, JSON, CSV, spreadsheets and text PDFs to Markdown. Marketplace limits are 3 MiB decoded and 5 MiB JSON. OCR is not included.
Each successful call consumes one plan request. Provider capacity limits are shared across callers; HTTP errors are not successful results.
No. OCR is not included. Supply a filename and base64 encoded document content.
The endpoint returns a JSON object containing the converted Markdown text, along with metadata such as the original filename, input and output byte sizes, and an indication of whether OCR was used.
The key fields in the response include "markdown" (the converted Markdown text), "format" (the original document format), "filename" (the name of the uploaded file), "inputBytes" (size of the input document), "outputBytes" (size of the output Markdown), and "ocrUsed" (indicating if OCR was applied).
The returned data is in JSON format, structured with key-value pairs. The "markdown" field contains the converted text, while other fields provide metadata about the conversion process.
The endpoint provides information about the converted document in Markdown format, including the original file's name and format, as well as the sizes of the input and output data.
The API supports common office and text formats for conversion, including formats like DOCX, PDF, TXT, and CSV, as long as the decoded document size does not exceed 10 MiB.
Users can customize their requests by providing a specific filename and the base64-encoded content of the document they wish to convert. This allows for flexibility in handling various document types.
The response data is organized in a JSON object with clearly defined fields. Each field serves a specific purpose, such as providing the converted Markdown text or metadata about the conversion process.
Typical use cases include converting documents for web publishing, generating Markdown for documentation, or preparing content for GitHub repositories, where Markdown formatting is required.
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