Ask AI
Skip to main content

Set an API File response

Function: Set an API File response​

This action allows you to specify a file that your API will send back as its response. This is useful when your API needs to deliver documents, images, or other file types directly to the caller.

Input​

  • File: The specific file you want your API to return. This could be a document, an image, a spreadsheet, or any other file type. This input is required.

Execution Flow​

Real-Life Examples​

Here are some practical ways you can use the "Set an API File response" action:

Example 1: Delivering a PDF Invoice​

Imagine you have an API endpoint that generates invoices. When a customer requests their invoice, you want the API to directly send them the PDF file.

  • Inputs:
    • File: A PDF file named "Invoice_12345.pdf" that was previously generated or retrieved.
  • Result: The API call successfully returns "Invoice_12345.pdf" to the customer's browser or application, allowing them to download or view it.

Example 2: Providing a CSV Data Export​

You might have an API that allows users to export data from your system as a CSV file.

  • Inputs:
    • File: A CSV file named "Customer_Report_2023.csv" containing the requested data, which was dynamically created by another action.
  • Result: The API responds with "Customer_Report_2023.csv", enabling the user to download and open the data in a spreadsheet program.

Example 3: Serving a Product Image​

Consider an e-commerce platform where an API provides product details, and you want to include the product's main image as a direct response.

  • Inputs:
    • File: A JPEG image file named "Product_Widget_Main.jpg" that represents the product.
  • Result: The API delivers "Product_Widget_Main.jpg" as its response, which can then be displayed directly in a web page or mobile app.