File download responses in FastAPI

Introduction

File download responses let your web app send files to users so they can save or open them on their device.

When you want users to download reports or documents from your app.

When providing images or videos for users to save.

When letting users download generated files like PDFs or CSVs.

When sharing software or data files through your API.

When allowing users to export their data from your app.

Syntax

FastAPI

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/download")
async def download_file():
    return FileResponse("path/to/file.txt", media_type="text/plain", filename="file.txt")

FileResponse sends a file from your server to the user.

The filename parameter sets the name the user sees when saving.

Examples

Sends a PDF file named monthly_report.pdf for download.

FastAPI

return FileResponse("files/report.pdf", media_type="application/pdf", filename="monthly_report.pdf")

Sends a JPEG image named vacation.jpg for download.

FastAPI

return FileResponse("images/photo.jpg", media_type="image/jpeg", filename="vacation.jpg")

Sends a CSV file named data_export.csv for download.

FastAPI

return FileResponse("data/export.csv", media_type="text/csv", filename="data_export.csv")

Sample Program

This FastAPI app has one route /download-text. When you visit it, the server sends the file example.txt for download with the same name.

FastAPI

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/download-text")
async def download_text_file():
    # This will send the file 'example.txt' located in the current folder
    return FileResponse("example.txt", media_type="text/plain", filename="example.txt")

Important Notes

Make sure the file path is correct and the file exists on the server.

Use the correct media_type so browsers handle the file properly.

FileResponse streams the file efficiently without loading it all into memory.

Summary

File download responses let users save files from your FastAPI app.

Use FileResponse with the file path, media type, and filename.

Always check file paths and use correct media types for best results.

Practice

1. What is the main purpose of using FileResponse in FastAPI?

easy

A. To upload a file from the client to the server

B. To read the contents of a file on the server

C. To delete a file on the server

D. To send a file to the client for download

Solution

1. Step 1: Understand the role of FileResponse

   FileResponse is designed to send files from the server to the client, enabling downloads.

2. Step 2: Differentiate from other file operations

   Uploading, deleting, or reading files are different operations and not handled by FileResponse.

3. Final Answer:

   To send a file to the client for download -> Option D

4. Quick Check:

   FileResponse sends files to clients [OK]

Hint: FileResponse is for sending files to users, not receiving [OK]

Common Mistakes:

• Confusing file download with upload
• Thinking FileResponse reads file content internally
• Assuming FileResponse deletes files

2. Which of the following is the correct way to import FileResponse in a FastAPI app?

easy

A. from fastapi.responses import FileResponse

B. from fastapi import FileResponse

C. import FileResponse from fastapi.responses

D. from fastapi.responses import file_response

Solution

1. Step 1: Recall correct import syntax

   FastAPI's FileResponse is located in the fastapi.responses module and imported using Python's standard import syntax.

2. Step 2: Check each option

   from fastapi.responses import FileResponse uses correct syntax and casing. from fastapi import FileResponse misses the responses submodule. import FileResponse from fastapi.responses uses wrong import order. from fastapi.responses import file_response uses incorrect casing.

3. Final Answer:

   from fastapi.responses import FileResponse -> Option A

4. Quick Check:

   Correct import = from fastapi.responses import FileResponse [OK]

Hint: Import FileResponse from fastapi.responses exactly [OK]

Common Mistakes:

• Omitting the 'responses' submodule
• Using wrong import syntax order
• Incorrect capitalization of FileResponse

3. Given this FastAPI endpoint code, what will the client receive when accessing /download?

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
async def download_file():
    return FileResponse('files/report.pdf', media_type='application/pdf', filename='report.pdf')

medium

A. The server returns a 404 error because the file path is missing

B. The client receives a JSON response with file metadata

C. The client downloads the file named 'report.pdf' with PDF content

D. The client downloads a file named 'files/report.pdf' without content type

Solution

1. Step 1: Analyze FileResponse parameters

   The path 'files/report.pdf' is given, media type is set to 'application/pdf', and filename is 'report.pdf'. This means the file will be sent as a PDF download named 'report.pdf'.

2. Step 2: Understand client behavior

   The client will receive the file content with correct media type and suggested filename, triggering a download.

3. Final Answer:

   The client downloads the file named 'report.pdf' with PDF content -> Option C

4. Quick Check:

   FileResponse sends file with given name and media type [OK]

Hint: FileResponse sends file content with given filename and media type [OK]

Common Mistakes:

• Assuming JSON response instead of file
• Thinking filename is the full path sent to client
• Ignoring media_type affects download behavior

4. Identify the error in this FastAPI endpoint for file download:

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/getfile')
def get_file():
    return FileResponse(path='myfile.txt', media_type='text/plain', filename=myfile.txt)

medium

A. FileResponse must be awaited since endpoint is async

B. Filename argument is not a string (missing quotes)

C. Path argument should be a URL, not a file path

D. Missing import for FileResponse

Solution

1. Step 1: Check filename argument syntax

   The filename argument is written as filename=myfile.txt without quotes, so Python treats it as a variable, causing a NameError.

2. Step 2: Verify other parts

   The endpoint is synchronous which is allowed. Path can be a file path. FileResponse is imported correctly. So only filename syntax is wrong.

3. Final Answer:

   Filename argument is not a string (missing quotes) -> Option B

4. Quick Check:

   Filename must be a string literal [OK]

Hint: Always quote filename strings in FileResponse [OK]

Common Mistakes:

• Forgetting quotes around filename string
• Assuming async needed for FileResponse
• Confusing file path with URL

5. You want to create a FastAPI endpoint that lets users download a CSV file named data.csv stored in static/files/. The file path may not exist sometimes. Which is the best way to handle this safely?

hard

A. Use FileResponse with a try-except block to catch file not found errors and return 404

B. Return FileResponse directly without checking; client will get an error if file missing

C. Use StreamingResponse without checking file existence

D. Send the file content as a plain string response

Solution

1. Step 1: Understand file existence risk

   Since the file may not exist, directly returning FileResponse risks server errors or confusing client errors.

2. Step 2: Implement error handling

   Using a try-except block to catch FileNotFoundError and returning a 404 response is best practice for user-friendly error handling.

3. Final Answer:

   Use FileResponse with a try-except block to catch file not found errors and return 404 -> Option A

4. Quick Check:

   Check file existence and handle errors gracefully [OK]

Hint: Always check file exists before FileResponse to avoid errors [OK]

Common Mistakes:

• Not handling missing files causing server errors
• Using StreamingResponse without reason
• Sending raw file content as string