Skip to content

easydoc-ai/easydoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cover-v5-optimized

📌 Introducing EasyDoc: Powerful Multimodal Document Processing API

EasyDoc API Platform

Static Badge chat on Discord follow on X(Twitter) Issues closed Discussion posts

README in English 简体中文版自述文件

💡 What is EasyDoc?

EasyDoc is a powerful multimodal document processing API that transforms unstructured documents into hierarchical JSON, making document assets perfect for your AI and LLM applications. Purpose-built for LLM pipelines, EasyDoc provides high-quality data for model inference, fine-tuning, and optimized context windows.

Why Choose EasyDoc?

  • 🧩 Content Block Identification:

    Transform scattered document text into meaningful knowledge blocks, moving far beyond simple line-by-line parsing. Our AI precisely identifies and groups related content, creating optimized context windows perfect for LLM consumption.

  • 🔍 Rich Semantic Extraction:

    Automatically reconstruct document hierarchies into intuitive mind maps, providing LLMs with rich context. Our deep understanding of document organization ensures your AI models receive complete, well-organized information for better reasoning and responses.

  • 🎨 Multimodal Content Parsing:

    Convert complex tables, figures, and visual data into JSON that your AI can actually understand. From multi-level tables to intricate diagrams, EasyDoc transforms multimodal content into machine-readable knowledge, supercharging your AI applications' capabilities.

🚀 Getting Started

1. Get an API key

To get started with the EasyDoc API, you'll first need to generate an API key. Follow these steps:

  1. Visit the API Key Management Page: Go to EasyDoc API Keys in your browser.
  2. Log In: If you aren't already logged in, sign in to your EasyDoc account using your credentials.
  3. Generate a New API Key: Once logged in, you will be able to create a new API key. Click on the "Create New Key" button.
  4. Copy Your API Key: After the key is generated, a unique API key will be displayed. Copy the key to your clipboard.
  5. Use the API Key: You can now use this API key to authenticate your requests when interacting with the EasyDoc API.

Make sure to keep your API key secure and do not expose it in public repositories or unauthorized places.

2. Use the REST API

You can interact with the EasyDoc API using the following two endpoints:

1. POST api/v1/parse

This API allows you to upload a file and create a parsing task.

Useful tips:

  • Supported file types: Ensure the uploaded file is in one of the following formats.
    • PDF (.pdf)
    • Text (.txt)
    • Word Documents (.docx, .doc)
    • PowerPoint Presentations (.pptx, .ppt)
  • File size limit: The maximum file size supported for each individual file is 100 MB. Please ensure that your uploaded files do not exceed this limit to avoid request failures.
  • Send a POST request to api/v1/parse including the file you want to upload in the request body. Replace api-key with your personal API key. For the fastest processing, we recommend starting with the Lite mode.
   curl https://api.easydoc.sh/api/v1/parse \
 -X POST \
 -H "api-key: your-api-key" \
 -F "file=@demo_document.pdf" \
 -F "mode=lite" \
  • Response: You will receive a task_id from the server response that you can use to track the status of the parsing task.

For detailed API documentation and usage instructions, see API Reference for POST /api/v1/parse.


2. GET api/v1/parse/{task_id}/result

This API allows you to retrieve the result of the parsing task you previously created.

  • Send a GET request to api/v1/parse/{task_id}/result, replacing {task_id} with the task ID returned from the previous step.
curl "https://api.easydoc.sh/api/v1/parse/{task_id}/result"  \
 -X GET \
 -H "api-key: your-api-key"
  • Response: You will receive the parsing result once the task is complete.

For more details on how to use this endpoint, see API Reference for GET /api/v1/parse/{task_id}/result.


💰 Pricing

🎉 Open Beta: $10 Balance for All Users!

Plan Price Free Trial Notes
Lite $2/1000 pages 1000 pages Basic features
Pro $8/1000 pages 1000 pages Advanced features
Premium (Beta) N/A 500 pages Cutting-edge features for trials, join waitlist to get your API key.

💬 Support and Feedback

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •