[PR #23534] feat: add Service API file preview endpoint #30294

Closed
opened 2026-02-21 20:47:13 -05:00 by yindo · 0 comments
Owner

Original Pull Request: https://github.com/langgenius/dify/pull/23534

State: closed
Merged: Yes


Summary

This PR implements a comprehensive file preview endpoint for the Service API, addressing the missing functionality identified in issue #23511. Currently, external applications built on Dify's Service API cannot display uploaded files to end users because the url field in message_files is empty/invalid and no preview endpoint exists.

Key Changes:

  • Implements GET /v1/files/:file_id/preview endpoint with optional as_attachment parameter
  • Multi-layer security validation: app token validation, file ownership verification, and tenant isolation
  • Streaming file responses optimized for large files with appropriate HTTP headers
  • Complete API documentation in English, Chinese, and Japanese templates
  • 12 comprehensive unit tests with 100% coverage

Problem Solved:

  • End users can now view images, PDFs, and other files shared in conversations
  • Developers can build complete file-sharing capabilities in Dify-powered applications
  • Service API now has feature parity with Console API for file operations

Screenshots

Before After
message_files.url field empty/invalid Stable preview URL: /v1/files/{file_id}/preview

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Fixes #23511

**Original Pull Request:** https://github.com/langgenius/dify/pull/23534 **State:** closed **Merged:** Yes --- ## Summary This PR implements a comprehensive file preview endpoint for the Service API, addressing the missing functionality identified in issue #23511. Currently, external applications built on Dify's Service API cannot display uploaded files to end users because the `url` field in `message_files` is empty/invalid and no preview endpoint exists. **Key Changes:** - Implements `GET /v1/files/:file_id/preview` endpoint with optional `as_attachment` parameter - Multi-layer security validation: app token validation, file ownership verification, and tenant isolation - Streaming file responses optimized for large files with appropriate HTTP headers - Complete API documentation in English, Chinese, and Japanese templates - 12 comprehensive unit tests with 100% coverage **Problem Solved:** - End users can now view images, PDFs, and other files shared in conversations - Developers can build complete file-sharing capabilities in Dify-powered applications - Service API now has feature parity with Console API for file operations ## Screenshots | Before | After | |--------|-------| | `message_files.url` field empty/invalid | Stable preview URL: `/v1/files/{file_id}/preview` | ## Checklist - [x] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos\!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods Fixes #23511
yindo added the pull-request label 2026-02-21 20:47:13 -05:00
yindo closed this issue 2026-02-21 20:47:13 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#30294