API Endpoints

\n\n> Client library compatible with Langchain, llamaindex, and haystack integrations coming soon.\n\n- [API Endpoints](#api-endpoints)\n - [Document Parsing](#document-parsing)\n - [Parse Any Document](#parse-any-document)\n - [Parse PDF](#parse-pdf)\n - [Parse PowerPoint](#parse-powerpoint)\n - [Parse Word Document](#parse-word-document)\n - [Media Parsing](#media-parsing)\n - [Parse Any Media](#parse-any-media)\n - [Parse Image](#parse-image)\n - [Process Image](#process-image)\n - [Parse Video](#parse-video)\n - [Parse Audio](#parse-audio)\n - [Website Parsing](#website-parsing)\n - [Parse Website](#parse-website)\n\n### Document Parsing\n\n#### Parse Any Document\n\nEndpoint: `/parse_document`\nMethod: POST\n\nParses PDF, PowerPoint, or Word documents.\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/document\" http://localhost:8000/parse_document\n```\n\n#### Parse PDF\n\nEndpoint: `/parse_document/pdf`\nMethod: POST\n\nParses PDF documents.\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/document.pdf\" http://localhost:8000/parse_document/pdf\n```\n\n#### Parse PowerPoint\n\nEndpoint: `/parse_document/ppt`\nMethod: POST\n\nParses PowerPoint presentations.\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/presentation.ppt\" http://localhost:8000/parse_document/ppt\n```\n\n#### Parse Word Document\n\nEndpoint: `/parse_document/docs`\nMethod: POST\n\nParses Word documents.\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/document.docx\" http://localhost:8000/parse_document/docs\n```\n\n### Media Parsing\n\n\n\n#### Parse Image\n\nEndpoint: `/parse_media/image`\nMethod: POST\n\nParses image files (PNG, JPEG, JPG, TIFF, WEBP).\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/image.jpg\" http://localhost:8000/parse_media/image\n```\n\n#### Process Image\n\nEndpoint: `/parse_media/process_image`\nMethod: POST\n\nProcesses an image with a specific task.\n\nPossible task inputs:\n`OCR | OCR with Region | Caption | Detailed Caption | More Detailed Caption | Object Detection | Dense Region Caption | Region Proposal`\n\nCurl command:\n```\ncurl -X POST -F \"image=@/path/to/image.jpg\" -F \"task=Caption\" -F \"prompt=Optional prompt\" http://localhost:8000/parse_media/process_image\n```\n\nArguments:\n- `image`: The image file\n- `task`: The processing task (e.g., Caption, Object Detection)\n- `prompt`: Optional prompt for certain tasks\n\n#### Parse Video\n\nEndpoint: `/parse_media/video`\nMethod: POST\n\nParses video files (MP4, AVI, MOV, MKV).\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/video.mp4\" http://localhost:8000/parse_media/video\n```\n\n#### Parse Audio\n\nEndpoint: `/parse_media/audio`\nMethod: POST\n\nParses audio files (MP3, WAV, FLAC).\n\nCurl command:\n```\ncurl -X POST -F \"file=@/path/to/audio.mp3\" http://localhost:8000/parse_media/audio\n```\n\n### Website Parsing\n\n#### Parse Website\n\nEndpoint: `/parse_website`\nMethod: POST\n\nParses a website given its URL.\n\nCurl command:\n```\ncurl -X POST -H \"Content-Type: application/json\" -d '{\"url\": \"https://example.com\"}' http://localhost:8000/parse_website\n```\nArguments:\n- `url`: The URL of the website to parse\n\n

\n\n## Coming Soon/ RoadMap\n🦙 LlamaIndex | Langchain | Haystack integrations coming soon\n📚 Batch processing data\n⭐ Dynamic chunking and structured data extraction based on specified Schema \n🛠️ One magic API: just feed in your file prompt what you want, and we will take care of the rest \n🔧 Dynamic model selection and support for external APIs \n📄 Batch processing for handling multiple files at once \n📦 New open-source model to replace Surya OCR and Marker \n\n**Final goal**: replace all the different models currently being used with a single MultiModel Model to parse any type of data and get the data you need.\n\n\n## License\nOmniParse is licensed under the GPL-3.0 license. See `LICENSE` for more information.\n\n## Acknowledgements\n\nThis project builds upon the remarkable [Marker](https://github.com/VikParuchuri/marker) project created by [Vik Paruchuri](https://twitter.com/VikParuchuri). We express our gratitude for the inspiration and foundation provided by this project. Special thanks to [Surya-OCR](https://github.com/VikParuchuri/surya) and [Texify](https://github.com/VikParuchuri/texify) for the OCR models extensively used in this project, and to [Crawl4AI](https://github.com/unclecode/crawl4ai) for their contributions.\n\nModels being used:\n- Surya OCR, Detect, Layout, Order, and Texify\n- Florence-2 base\n- Whisper Small\n\nThank you to the authors for their contributions to these models.\n\n---\n\n## Contact\n

\n \n $\"Star$ \n \n

\nFor any inquiries, please contact us at adithyaskolavi@gmail.com\n\n\n","has_starred","hub_user","immutable_tags_settings",{"_86":11,"_87":88},"enabled","rules",[89],".*","is_automated","permissions",{"_93":21,"_94":11,"_95":11},"read","write","admin","user","storage_size",10790714644,"orgData","recentTags",[102],{"_103":55,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_61":129,"_130":105,"_131":33,"_132":67,"_43":133,"_134":135,"_136":120,"_137":129,"_138":76,"_139":21},"content_type","creator",21040876,"digest","sha256:077c471df96fc3ca88f17059467ea42b67085c529c7e651b2fbea9561272277e","full_size",9352066646,"id",709835821,"images",[114],{"_115":116,"_106":107,"_117":118,"_119":120,"_121":122,"_123":124,"_125":118,"_126":-5,"_127":109,"_73":76,"_128":-5},"architecture","amd64","features","","last_pulled","2026-10-14T21:10:25.215741625Z","last_pushed","2024-07-02T18:04:39Z","os","linux","os_features","os_version","size","variant","2024-07-02T18:04:38.470826Z","last_updater","last_updater_username","media_type","0.1","repository",24478487,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":153,"_163":164,"_147":173,"_174":11},{"_40":154,"_53":158,"_56":57,"_58":59,"_60":11,"_61":62,"_63":64,"_65":159,"_43":35,"_32":33,"_68":69,"_70":55,"_71":72,"_73":74,"_75":76,"_77":-5,"_78":79,"_80":81,"_82":11,"_83":33,"_84":160,"_90":11,"_91":162,"_96":33,"_97":98},[155,156,157],{"_43":44,"_45":46},{"_43":48,"_45":49},{"_43":51,"_45":52},[55],[67],{"_86":11,"_87":161},[89],{"_93":21,"_94":11,"_95":11},"tags",{"_165":74,"_166":-5,"_167":-5,"_168":169},"count","next","previous","results",[170],{"_103":55,"_104":105,"_106":107,"_108":109,"_110":111,"_112":171,"_61":129,"_130":105,"_131":33,"_132":67,"_43":133,"_134":135,"_136":120,"_137":129,"_138":76,"_139":21},[172],{"_115":116,"_106":107,"_117":118,"_119":120,"_121":122,"_123":124,"_125":118,"_126":-5,"_127":109,"_73":76,"_128":-5},[],"canDeleteTags","actionData","errors"]

savatar101/omniparse

Tags for savatar101/omniparse