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

Common Specification

API Overview

• APIs Provided by Fess
• Base URL
• Response Envelope
• Error Response
• Authentication and Sessions
• Streaming Format
• Types of APIs

Search APIs

Search API

• Document Search
• Fetching All Documents (Scroll Search / NDJSON)

Label API

• Fetching Labels
• Usage Examples
• Error Response

Popular Words API

• Fetching the Popular Words List
• Usage Examples
• Error Response

Suggest API

• Fetching the Suggest Words List
• Usage Examples
• Error Response

Related Queries and Content API

• Fetching Related Queries
• Fetching Related Content

Health API

• Fetching Status
• Usage Examples
• Response and Error Response

Authentication and UI

Authentication / Session API

• Overview
• Common User Information (UserPayload)
• Fetching Authentication State
• Login
• Logout
• Password Change

UI Config API

• Overview
• Fetching UI Configuration

User Feature APIs

Favorites API

• Fetching Favorite Documents List
• Fetching Favorite Status
• Adding a Favorite

Click Log API

• Recording a Click

Cache API

• Fetching a Cached Document

AI Chat API

Chat API

• Overview
• Prerequisites
• Authentication and CSRF
• Rate Limiting
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• 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