X

File:

Home > Function Reference > File

Jump to a Section

  • Convert

    Converts a file to a different type.

    Options

    • Source File Type (drop down menu): The current file type.
    • Target File Type (drop down menu): Choices of what type the file will be converted to.

    Input Fields

    • File
      • File Content (file)

    Output Fields

    • File
      • File Content (file): The new file content.

  • Download

    Downloads a file to the Designer file system over http or https.  For example, any file that you can get to through a URL in your browser - like an image or a document file - you can download using this function.

    To use this function, enter the URL - including the http:// or https:// part - in the URL input.  Optionally you can also use the Query section to build a query string, i.e. if you wanted to download a file from https://www.example.com/download?filename=foo.txt then you could express this in one of two ways.  Either a) you could put that whole string into the URL input, or b) you could set URL to https://www.example.com/download and create an input filename in the Query section and enter a value of foo.txt.  The latter method is easier when the value of filename comes from a previous step in the Flow - you can just drag the field into the input.

    You can also optionally set headers in the request.  For example if the site requires authorization, you could add a header “Authorization: Bearer my-token” by adding an Authorization key to the Headers section and setting its value to Bearer my-token.  Similarly you could set “Content-type: application/image” the same way.

    The primary output is File Content - this is the ID to use in subsequent cards.  For example, if the next step of the Flow is to upload this file to Box, drag the File Content output of this card into the File input of the Box upload card.

    Input Fields

    • URL (text) - required: the URL of the request, including the protocol http:// or https://
    • Headers (optional) - user-created fields (text) to define headers to use in the file request
    • Query (optional) - user-created fields (text) to define query parameters to use in the file request

    Output Fields

    • File Content (file): the ID of the file contents
    • Filename (text): the filename of the downloaded file
    • Size (number): size of the downloaded file, in bytes

    File Size Limits

    • The file size limit for the download function is 1.5GB and is not specific to connected applications in the Flow.

    Example

  • Info

    Retrieves information about a file.  To use it, set the input to the File Contents of a file you have downloaded previously in the Flow. The output will give you helpful information about it.

    Input Fields

    • File Content (file): the ID of the file contents

    Output Fields

    • Filename (text):  the filename of the downloaded file
    • Extension (text):  the extension of the file name, which (often) defines the file type - e.g. .jpg, .png, .csv, etc.
    • Size (number):  size of the file, in bytes
    • Created (date):  the date/time that the file was created
    • Updated (date):  the date/time that the file was updated

    Example

    Here’s an example of a successful execution, showing an jpeg file downloaded from google images:

  • Large Multipart Upload

    NOTE : This card should only be used for files larger than 1MB. Smaller file should be uploaded using the regular multipart upload.

    Uploads a file from the the software’s filesystem to a web service, using http or https, via multipart form-data. Please consider the api you will be using to fetch the required input field data.

    The output is dependent on the response from the service.  To access a particular response properly, create an output with the same name as the key in the response object.

    Input Fields

    • File  File Content (file) - required: The ID of the file contents to upload or if you’re using test function you can choose a file to upload. File Name (string) - required_: The file name including the extension, for example test.pdf.
    • Http
      • URL (text) - required: the URL of the request, including the protocol http:// or https://
      • Method (option) - required: the http method to use - PUT or POST.
      • Headers (optional) - user-created fields (text) to define headers to use in the file request
    • Data
      • Key and Value pairs - You can found these value in the upload target API documentation.

    Output Fields

    • (user created)

  • Multipart Upload

    NOTE : This card should only be used for files less than 1MB. Larger file should be uploaded using the large multipart upload.

    Uploads a file from the the software’s filesystem to a web service, using http or https, via multipart form-data. Please consider the api you will be be using to fetch the required input field data.

    The output is dependent on the response from the service.  To access a particular response properly, create an output with the same name as the key in the response object.

    Input Fields

    • File  File Content (file) - required: The ID of the file contents to upload or if you’re using test function you can choose a file to upload. File Name (string) - required_: The file name including the extension, for example test.pdf.
    • Http
      • URL (text) - required: the URL of the request, including the protocol http:// or https://
      • Method (option) - required: the http method to use - PUT or POST.
      • Headers (optional) - user-created fields (text) to define headers to use in the file request
    • Data
      • Key and Value pairs - You can found these value in the upload target API documentation.

    Output Fields

    • (user created)

  • Upload

    Uploads a file from the the software’s filesystem to a web service, using http or https.

    To use this function, first identify the file to upload by dragging an existing File type - typically called File Contents - from a previous card in the Flow, for example a download card from another cloud service.  Then specify the URL - including the http:// or https:// part and any query string parameters - in the URL input.  Then select the http method - PUT or POST - and set any headers required by the service.  Typically there will be some headers required, for authentication at least.  For example if the site requires authorization, you could add a header “Authorization: Bearer my-token” by adding an Authorization key to the Headers section and setting its value to Bearer my-token.  Similarly you could set “Content-type: application/image” the same way.

    The output is dependent on the response from the service.  To access a particular response properly, create an output with the same name as the key in the response object.

    Important note: this function is not capable of doing multi-part upload - that functionality is in development now, please let us know if you need it sooner.

    Input Fields

    • File Content (file) - required: the ID of the file contents to upload
    • URL (text) - required: the URL of the request, including the protocol http:// or https://
    • Method (option) - required: the http method to use - PUT or POST
    • Headers (optional) - user-created fields (text) to define headers to use in the file request

    Output Fields

    • (user created)

    Example

    Here is an example of accessing the Algorithmia file system, one of our partners.  

    Algorithmia requires that the full file path and filename of the destination file be specified in the URL.  

    They also require an authentication token (replace that with a real one) and a specific Content-Type.