Fess API Guide

Getting Started

Introduction

• Target Audience
• Before You Read This Document
• API Usage Prerequisites
• Online Access
• Technical Support Contact
• References to Related Third-Party Websites
• How to Send Comments and Suggestions

API Quick Start

• Get Started in 5 Minutes
• Using Postman
• Code Samples by Programming Language
• API Version Compatibility
• Troubleshooting
• Next Steps

Search APIs

API Overview

• APIs Provided by Fess
• Base URL
• Authentication
• HTTP Methods
• Response Format
• Error Handling
• Types of APIs

Search API

• Fetching Search Results
• Searching All Documents
• Error Response

Label API

• Fetching Labels
• Usage Examples
• Error Response

Popular Words API

• Fetching Popular Words List
• Error Response

Suggest API

• Fetching Suggest Words List
• Error Response

Health API

• Fetching Status
• Error Response

Chat API

• Overview
• Prerequisites
• Non-Streaming API
• Streaming API
• Error Handling
• Rate Limiting
• Security
• References

Admin APIs

Admin API Reference

• Admin API Overview
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• Storage API
• Plugin API
• Dict API
• SearchLog API