AI Agent Hub
Back to skills
RAGFlow Knowledge Base API Handbook icon

RAGFlow Knowledge Base API Handbook

Content Creation Updated 2026.08.30

Paste the following prompt into your AI chat to install this skill:

Please install @user_c02d38d8/gggsfsdf according to https://skillhub.cn/install/skillhub.md.

About this skill

Problem Being Solved

When integrating RAGFlow, the harder part is not calling one endpoint, but keeping parameters consistent across knowledge bases, documents, chunks, retrieval, metadata, and parser settings. Manually scanning docs can miss key fields such as parser_config, chunk_method, and authentication differences, causing upload parsing failures or retrieval results that do not match expectations.

How the Skill Works

This RAGFlow Knowledge Base API Handbook organizes the API reference by workflow:
- Knowledge base management: covers creation, listing, editing, and deletion, with settings such as embedding_model, permission, and chunk_method.
- Document management: describes file upload, URL import, listing, editing, downloading, and deletion, emphasizing dataset_id, document_id, and processing status run.
- Parsing and chunking: explains chunking methods such as naive, paper, table, qa, and parent_child, plus parser_config fields for token size, delimiters, layout recognition, and table/image context.
- Retrieval and stats: includes knowledge-base retrieval, usage statistics, re-embedding, and error-code notes for debugging recall and parsing issues.

Boundaries and Cautions

The material is an API reference and does not replace server-side permission governance. Some endpoints use session or beta token authentication, so confirm the credential type before calling. Changes to chunk_method or parser_config often require re-parsing to take effect; deleting a knowledge base cascades to documents, chunks, files, and vector indexes, so use caution in production.

Use Cases

  • When choosing RAGFlow `chunk_method` and `parser_config` for a new dataset, verify token size, delimiters, and table/image context settings.
  • When PDF, DOCX, or Excel uploads fail parsing, check `run` status, `parser_config`, and error codes against the manual.
  • When building an internal RAG service, call retrieval, usage stats, and re-embedding endpoints to validate `embedding_model` and recall behavior.
  • When managing multi-source documents, use document list filters such as `metadata_condition`, `suffix`, and `run` to locate problematic files.

Best For

  • Backend engineers: integrating RAGFlow APIs for datasets, documents, chunks, retrieval, and parser settings.
  • RAG application engineers: selecting `chunk_method` and `parser_config` while debugging parsing, chunking, and recall issues.
  • Knowledge base operators: bulk uploading PDF/DOCX/Excel and filtering documents by status, metadata, and suffix.
  • Full-stack developers: wrapping dataset listing, retrieval, download, deletion, and re-embedding endpoints in internal RAG services.