[DOCS]: API Doc update and add #282

New Issue

2026-02-16T05:19:43-05:00

yindo commented

2026-02-16 05:19:43 -05:00

Originally created by @xiangshaonumber1 on GitHub (Nov 26, 2025).

Type of Documentation Change

Content update

Documentation Page URL or Path

https://docs.dify.ai/api-reference/models/get-available-embedding-models

Current Content

Suggested Changes

I found that there is only an API for obtaining the embedding model, but during operation, I also need the API interface for the rerank model, which I have not seen yet. I hope to add new interfaces and documentation
Based on this, it was also found that many APIs for other functions are missing, such as the API for the [Preview Block] function
As a source platform, dify also provides APIs, which is a great decision. However, the lack of API documentation also brings certain difficulties to users. We hope to strengthen the maintenance of documentation, which is really important

Reason for Change

No response

Code of Conduct

I agree to follow Dify's documentation contribution guidelines
I have searched for existing issues search for existing issues, including closed ones.
I confirm that I am using English to submit this report, otherwise it will be closed.
【中文用户 & Non English User】请使用英语提交，否则会被关闭：）
Please do not modify this template :) and fill in all the required fields.

Originally created by @xiangshaonumber1 on GitHub (Nov 26, 2025). ### Type of Documentation Change Content update ### Documentation Page URL or Path https://docs.dify.ai/api-reference/models/get-available-embedding-models ### Current Content <img width="1044" height="805" alt="Image" src="https://github.com/user-attachments/assets/d32951b3-9a2c-454d-9810-198137a350dc" /> ### Suggested Changes I found that there is only an API for obtaining the embedding model, but during operation, I also need the API interface for the rerank model, which I have not seen yet. I hope to add new interfaces and documentation Based on this, it was also found that many APIs for other functions are missing, such as the API for the [Preview Block] function As a source platform, dify also provides APIs, which is a great decision. However, the lack of API documentation also brings certain difficulties to users. We hope to strengthen the maintenance of documentation, which is really important ### Reason for Change _No response_ ### Code of Conduct - [x] I agree to follow Dify's documentation [contribution guidelines](https://github.com/langgenius/dify/blob/0277a37fcad5ad86aeb239485c27fffd5cd90043/CONTRIBUTING.md) - [x] I have searched for existing issues [search for existing issues](https://github.com/langgenius/dify/issues), including closed ones. - [x] I confirm that I am using English to submit this report, otherwise it will be closed. - [x] 【中文用户 & Non English User】请使用英语提交，否则会被关闭：） - [x] Please do not modify this template :) and fill in all the required fields.

yindo added the documentation enhancement labels 2026-02-16 05:19:43 -05:00

yindo closed this issue

2026-02-16 05:19:44 -05:00

yindo commented

2026-02-16 05:19:44 -05:00

@dosubot[bot] commented on GitHub (Dec 7, 2025):

Hi, @xiangshaonumber1. I'm Dosu, and I'm helping the dify-docs team manage their backlog and am marking this issue as stale.

Issue Summary:

You requested API documentation for the rerank model and other missing functions like the Preview Block.
Currently, only the embedding model API is documented.
The goal is to have comprehensive API docs to improve the user experience on the Dify platform.
There has been no further activity or comments on this issue since it was opened.

Next Steps:

Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here.
If I do not hear from you, this issue will be automatically closed in 5 days.

Thank you for your understanding and contribution!

@dosubot[bot] commented on GitHub (Dec 7, 2025): Hi, @xiangshaonumber1. I'm [Dosu](https://dosu.dev), and I'm helping the dify-docs team manage their backlog and am marking this issue as stale. **Issue Summary:** - You requested API documentation for the rerank model and other missing functions like the Preview Block. - Currently, only the embedding model API is documented. - The goal is to have comprehensive API docs to improve the user experience on the Dify platform. - There has been no further activity or comments on this issue since it was opened. **Next Steps:** - Please let me know if this issue is still relevant to the latest version of the dify-docs repository by commenting here. - If I do not hear from you, this issue will be automatically closed in 5 days. Thank you for your understanding and contribution!

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: langgenius/dify-docs#282