πŸ“™Readable Parser

Convert your documents to Markdown [For FreeπŸ”₯]

v1.0.0

1. Introduction

We provide the following Free APIs to help you convert various documents into markdown format text.

  • Request Parsing: You can use this API to parse your file or URL. The parsing process is asynchronous. After successful submission, you will receive a unique task_id that can be used to query the parsing status and fetch the parsed result.

  • Check Parsing Status: With this API, you can check the parsing status of the document with the task_id.

  • Fetch Parsed Result: After the parsing task is completed, you can fetch the markdown result through this API with the task_id.

DocumentSupported

PDF

βœ…

Docx

βœ…

HTML

βœ…

Excel

βœ…

CSV

βœ…

For detailed usage of the API, please refer to the API section below.

2. Auth Token

You can obtain an API Key on the Account page.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include your API key in an Authorization HTTP header as follows:

Authorization: Bearer CHATOFAI_API_KEY

Example curl command:

curl https://chatof.ai/path\
  -H "Authorization: Bearer $CHATOFAI_API_KEY"

Example with python

import requests
url = "https://chatof.ai/path"
headers = {
    "Authorization": f"Bearer {CHATOFAI_API_KEY}"
}
resp = requests.get(url, headers=headers)

3. API

Base URL

3.1 Request Parsing

POST /api-parser/file/async/parser

Request Parameters

NamePositionTypeRequiredDescription

Authorization

header

string

yes

Token, check Auth Token for details

body

body

object

no

Β» file

body

string(binary)

no

File, required when type is pdf, docx, csv, excel

Β» url

body

string

no

URL, required when type is html

Β» type

body

string

yes

parser type, options: pdf, docx, html, excel, csv

Β» options

body

string

no

JSON string, see the documentation for supported options

Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "task_id": "avhwk001"
  }
}

Response Data Structure

Status Code 200

NameTypeDescription

Β» code

integer

Β» msg

string

Β» data

object

»» task_id

string

3.2 Check Parsing Status

GET /api-parser/file/async/parser/status

Request Parameters

NamePositionTypeRequiredDescription

task_id

query

string

yes

Task ID

Authorization

header

string

yes

Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "success",
    "err_msg": ""
  }
}

Response Data Structure

NameTypeDescription

Β» code

integer

Β» msg

string

Β» data

object

»» status

string

pending

processing

success

failed

»» error_msg

string

3.3 Fetch Parsed Result

GET /api-parser/file/async/parser/download

Request Parameters

NamePositionTypeRequiredDescription

task_id

query

string

yes

Authorization

header

string

yes

Response

{
  "code": 0,
  "msg": "success",
  "data": {
    "markdown": "### Title\n\nContent"
  }
}

Response Data Structure

NameTypeDescription

Β» code

integer

Β» msg

string

Β» data

object

»» markdown

string

Parsed Markdown Text

4. Limits

There are restrictions on the request frequency to prevent abuse of the interface. You are limited to making 1 request per second and 100 requests per day. If you exceed this limit, your API calls will be restricted. Please note that the rate limit is applied at the user level, rather than the interface level. This means you are not allowed to make more than two simultaneous requests to the interface. If you have higher frequency requirements for your requests, please get in touch with us support@chatof.ai

Last updated