Media_files

>>>

GET /api/v4/folders/:folder_id/media_files
List of media files. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  media_files: [
    {
      "id": 271,
      "name": "media_file",
      "common_media_file": false,
      "media_type": "photo",
      "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
      "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
      "file_size": "1.18 MB",
      "created_date": "06/20/22",
      "note": NOTE,
      "is_cutout": false,
      "source": "my folder || shared || stock || content request || cutout",
      "s3_key": "S3_KEY" (NOTE: add 16/04/24),
      "additional_version": {
        "id": 272,
        "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
        "deleted": false
      } (NOTE: add 17/06/24),
      "content_request": {
        "id": 180,
        "name": "aasdas",
        "recipient": "fds",
        "prompt": "dsfsdf",
        "expiration_date": "2022-08-11T00:00:00.000Z",
        "status": "completed",
        "time_type": "One-Time",
        "link_for_copy": "/content_requests/ab218b2ae8f2d02f",
        "token": "ab218b2ae8f2d02f"
      }
    },
    ...
  ],
  meta: {
    total_count: 3
  }
}

Params

Param name Description
folder_id
required

ID of folder

Validations:

  • Must be a Integer
query
optional

search in folder

Validations:

  • Must be a String
sort_by
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
page
optional

Validations:

  • Must be a Integer
per_page
optional

Validations:

  • Must be a Integer
>>>

GET /api/v4/media_files/search
search media file in Gallery. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  media_files: [
    {
      "id": 271,
      "name": "media_file",
      "common_media_file": false,
      "media_type": "photo",
      "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
      "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
      "file_size": "1.18 MB",
      "created_date": "06/20/22",
      "note": NOTE,
      "is_cutout": false,
      "source": "my folder || shared || stock || content request || cutout",
      "s3_key": "S3_KEY" (NOTE: add 16/04/24),
      "additional_version": {
        "id": 272,
        "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
        "deleted": false
      } (NOTE: add 17/06/24)
      "content_request": {
        "id": 180,
        "name": "aasdas",
        "recipient": "fds",
        "prompt": "dsfsdf",
        "expiration_date": "2022-08-11T00:00:00.000Z",
        "status": "completed",
        "time_type": "One-Time",
        "link_for_copy": "/content_requests/ab218b2ae8f2d02f",
        "token": "ab218b2ae8f2d02f"
      }
    },
    ...
  ],
  meta: {
    total_count: 3
  }
}

Params

Param name Description
folder_id
optional , nil allowed

ID of folder

Validations:

  • Must be a Integer
query
optional

Validations:

  • Must be a String
sort_by
optional

Validations:

  • Must be one of: created_at, name.
sort_to
optional

Validations:

  • Must be one of: asc, desc.
page
optional

Validations:

  • Must be a Integer
per_page
optional

Validations:

  • Must be a Integer
>>>

GET /api/v4/media_files/:id
Show media file. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  "id": 271,
  "name": "media_file",
  "common_media_file": false,
  "media_type": "photo",
  "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
  "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
  "file_size": "1.18 MB",
  "created_date": "06/20/22",
  "note": NOTE,
  "is_cutout": false,
  "source": "my folder || shared || stock || content request || cutout",
  "s3_key": "S3_KEY" (NOTE: add 16/04/24),
  "additional_version": {
    "id": 272,
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
    "deleted": false
  } (NOTE: add 17/06/24)
  "content_request": {
    "id": 180,
    "name": "aasdas",
    "recipient": "fds",
    "prompt": "dsfsdf",
    "expiration_date": "2022-08-11T00:00:00.000Z",
    "status": "completed",
    "time_type": "One-Time",
    "link_for_copy": "/content_requests/ab218b2ae8f2d02f",
    "token": "ab218b2ae8f2d02f"
  }
}

Params

Param name Description
id
required

ID of preset

Validations:

  • Must be a Integer
>>>

POST /api/v4/folders/:folder_id/media_files
Create media file. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Request body example ↑

{
  "media_file": {
    "name": "media_file",
    "s3_key": "s3_key",
    "format_type": "png",
    "media_type": "photo",
    "size": 109495405,
    "is_cutout": true,
    "origin_id": 14
  }
}

Success response body ↑

{
  "id": 271,
  "name": "media_file",
  "common_media_file": false,
  "media_type": "photo",
  "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.png",
  "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
  "file_size": "1.18 MB",
  "created_date": "06/20/22",
  "note": null,
  "is_cutout": true,
  "source": "my folder || shared || stock || content request || cutout",
  "s3_key": "S3_KEY" (NOTE: add 16/04/24),
  "additional_version": {
    "id": 272,
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
    "deleted": false
  } (NOTE: add 17/06/24)
}

Params

Param name Description
folder_id
required

ID of parrent folder

Validations:

  • Must be a Integer
media_file
required

Validations:

  • Must be a Hash
media_file[name]
required

Name of media file

Validations:

  • Must be a String
media_file[s3_key]
required

AWS s3 token

Validations:

  • Must be a String
media_file[format_type]
required

Media File extension

Validations:

  • Must be a String
media_file[media_type]
required

Media type of file

Validations:

  • Must be one of: photo, video.
media_file[size]
required

Media File size

Validations:

  • Must be a Integer
media_file[is_cutout]
optional

Is this file cotout

Validations:

  • Must be one of: true, false, 1, 0.
media_file[origin_id]
optional

ID of origin media_file FOR CUTOUT ONLY

Validations:

  • Must be a Integer
>>>

POST /api/v4/folders/:folder_id/media_files/bulk_create
Bulk create media files

Params

Param name Description
folder_id
required

ID of parrent folder

Validations:

  • Must be a Integer
media_files
required

Validations:

  • Must be an Array of nested elements
media_files[name]
required

Validations:

  • Must be a String
media_files[s3_key]
required

Validations:

  • Must be a String
media_files[format_type]
required

Media File extension

Validations:

  • Must be a String
media_files[media_type]
required

Media type of file

Validations:

  • Must be one of: photo, video.
media_files[size]
required

Validations:

  • Must be a Integer
>>>

PUT /api/v4/media_files/:id
Update media file. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Request body example ↑

{
  "media_file": {
    "name": "updated_media_file",
    "media_type": "photo",
    "size": 109495405,
    "is_cutout": true,
    "origin_id": 14
  }
}

Success response body ↑

{
  "id": 271,
  "name": "updated_media_file",
  "common_media_file": false,
  "media_type": "photo",
  "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.png",
  "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
  "file_size": "1.18 MB",
  "created_date": "06/20/22",
  "note": null,
  "is_cutout": true,
  "source": "my folder || shared || stock || content request || cutout",
  "s3_key": "S3_KEY" (NOTE: add 16/04/24),
  "additional_version": {
    "id": 272,
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
    "deleted": false
  } (NOTE: add 17/06/24)
}

Params

Param name Description
id
required

ID of media file

Validations:

  • Must be a Integer
media_file
required

Validations:

  • Must be a Hash
media_file[name]
optional

Name of media file

Validations:

  • Must be a String
media_file[s3_key]
optional

AWS s3 token

Validations:

  • Must be a String
media_file[is_cutout]
optional

Is this file cotout

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/v4/media_files/:id
Delete media file

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

ID of preset

Validations:

  • Must be a Integer
>>>

POST /api/v4/media_files/:id/share_with_team
Share with team

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
team_ids
required

Validations:

  • Must be an array of Integer
>>>

PUT /api/v4/media_files/move
Move user_media_files. Last update: 10/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "folder_id": 1,
  "ids": [2, 3, ...]
}

Success response body ↑

{
  media_files: [
    {
      "id": 271,
      "name": "media_file",
      "common_media_file": false,
      "media_type": "photo",
      "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
      "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type" (NOTE: add 10/04/24),
      "file_size": "1.18 MB",
      "created_date": "06/20/22",
      "note": null,
      "is_cutout": false,
      "source": "my folder || shared || stock || content request || cutout",
      "s3_key": "S3_KEY" (NOTE: add 16/04/24),
      "additional_version": {
        "id": 272,
        "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
        "deleted": false
      } (NOTE: add 17/06/24)
    },
    ...
  ],
  meta: {
    total_count: 3
  }
}

Params

Param name Description
folder_id
optional

Folder to wich we want to move user_media_files

Validations:

  • Must be a Integer
ids
optional

IDs of user_media_files wich we want to move

Validations:

  • Must be an array of Integer
>>>

GET /api/v4/media_files/bulk_show_by_s3_keys
search by s3_keys. Added: 15/04/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  [
    {
      "id": 271,
      "name": "media_file",
      "common_media_file": false,
      "media_type": "photo",
      "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
      "link_for_additional_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
      "file_size": "1.18 MB",
      "created_date": "06/20/22",
      "note": NOTE,
      "is_cutout": false,
      "source": "my folder || shared || stock || content request || cutout",
      "s3_key": "S3_KEY" (NOTE: add 16/04/24),
      "additional_version": {
        "id": 272,
        "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/s3_key.format_type",
        "deleted": false
      } (NOTE: add 17/06/24)
    },
    ...
  ]
}

Params

Param name Description
s3_keys
required

Validations:

  • Must be an array of String
>>>

POST api/v4/media_files/:s3_key/remove_bg

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  "success": true,
  "result": Base64String
}

Params

Param name Description
s3_key
required

Validations:

  • Must be a String
format_type
required

Validations:

  • Must be a String
location
required

From what location was requested removeBG

Validations:

  • Must be one of: gallery, templateEditor, signUpForm.
template_id
optional

REQUIRED if location is templateEditor

Validations:

  • Must be a Integer