Common Parameter

Introduction

These are the common parameter available to all media function request and these are used to manipulate output response.

It will be the name of disk where you want to save the file after operation. You can configure disk from Dashboard

  • Default: temp
  • Allowed: temp,oyyi,Or your own custom storage
  • Type: String
    In case of temporary storage all file related to that request will be deleted after 30 Minutes from Server. To Preserve file you need to add your own disk.And To use oyyi storage you need to verify your account before using it.

  • converted

    You can pass filename for final file. You can also prepend path of directory to store your file. For e.g. my_converted_image.jpg or user_1/my_converted_image.jpg
    • Default: random
    • Type: String

  • converted_visibility

    File visibility allow to store file with certain visibility. It can also be configured while creating new disk from dashboard.
    • Default: public
    • Allowed: public or private
      Visibility parameter are only supported some storage type like AWS S3, Digital Ocean Space or any s3 compatible storage service.

  • original

    You can pass filename for original file, and we will rename original file before uploading it. You can also prepend path of directory to store your file. For e.g. original.jpg or user/original.jpg
    • Default: random
    • Type: String

  • original_visibility

    OriginalFile visibility allow to store file with certain visibility. You can use it to store client file in private or public mode according to your need.
    • Default: public
    • Allowed: public or private
      Visibility parameter are only supported some storage type like AWS S3, Digital Ocean Space or any s3 compatible storage service.

  • upload_original

    This parameter allow you to control weather you want to store the original file also over the disk or not.
    • Default: false
    • Type: boolean

  • queue

    By disabling this option, your job won't be queued and will be process immediately
    • Default: true
    • Type: boolean
      Don't make it false, otherwise request time will be increase significantly. And in case of large file it can take upto several minutes and might cause server timeout error.

  • notify

    This parameter can be used as webhook to get notification when request finished processing, useful when your request are doing some heavy tasks or time-consuming task
    • Default: none
    • Type: Url string