pixelbin-python-sdk/documentation/platform/ASSETS.md at main · pixelbin-io/pixelbin-python-sdk

Back to Pixelbin API docs

Assets Methods

Asset Uploader Service

addCredentials
updateCredentials
deleteCredentials
getFileById
getFileByFileId
updateFile
deleteFile
deleteFiles
createFolder
getFolderDetails
updateFolder
deleteFolder
getFolderAncestors
listFiles
listFilesPaginator
getDefaultAssetForPlayground
getModules
getModule
addPreset
getPresets
updatePreset
deletePreset
getPreset
fileUpload
urlUpload
createSignedUrl
createSignedUrlV2

Methods with example and description

addCredentials

Summary: Add credentials for a transformation module.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.addCredentials(
        credentials={"region":"ap-south-1","accessKeyId":"123456789ABC","secretAccessKey":"DUMMY1234567890"}, 
        pluginId="awsRek")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.addCredentialsAsync(
        credentials={"region":"ap-south-1","accessKeyId":"123456789ABC","secretAccessKey":"DUMMY1234567890"}, 
        pluginId="awsRek"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
credentials	Any	yes	Credentials of the plugin
pluginId	str	yes	Unique identifier for the plugin this credential belongs to

Add a transformation modules's credentials for an organization.

Returned Response:

AddCredentialsResponse

Success

Example:

{
  "_id": "123ee789-7ae8-4336-b9bd-e4f33c049002",
  "createdAt": "2022-10-04T09:52:09.545Z",
  "updatedAt": "2022-10-04T09:52:09.545Z",
  "orgId": 23,
  "pluginId": "awsRek"
}

updateCredentials

Summary: Update credentials of a transformation module.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.updateCredentials( 
        pluginId="awsRek",
        credentials={"region":"ap-south-1","accessKeyId":"123456789ABC","secretAccessKey":"DUMMY1234567890"})
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.updateCredentialsAsync( 
        pluginId="awsRek",
        credentials={"region":"ap-south-1","accessKeyId":"123456789ABC","secretAccessKey":"DUMMY1234567890"}))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
pluginId	str	yes	ID of the plugin whose credentials are being updated
credentials	Any	yes	Credentials of the plugin

Update credentials of a transformation module, for an organization.

Returned Response:

AddCredentialsResponse

Success

Example:

{
  "_id": "123ee789-7ae8-4336-b9bd-e4f33c049002",
  "createdAt": "2022-10-04T09:52:09.545Z",
  "updatedAt": "2022-10-04T09:52:09.545Z",
  "orgId": 23,
  "pluginId": "awsRek"
}

deleteCredentials

Summary: Delete credentials of a transformation module.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.deleteCredentials( 
        pluginId="awsRek")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.deleteCredentialsAsync( 
        pluginId="awsRek"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
pluginId	str	yes	ID of the plugin whose credentials are being deleted

Delete credentials of a transformation module, for an organization.

Returned Response:

AddCredentialsResponse

Success

Example:

{
  "_id": "123ee789-7ae8-4336-b9bd-e4f33c049002",
  "createdAt": "2022-10-04T09:52:09.545Z",
  "updatedAt": "2022-10-04T09:52:09.545Z",
  "orgId": 23,
  "pluginId": "awsRek"
}

getFileById

Summary: Get file details with _id

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getFileById( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getFileByIdAsync( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
id	str	yes	_id of File

Returned Response:

FilesResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

getFileByFileId

Summary: Get file details with fileId

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getFileByFileId( 
        fileId="path/to/file/name")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getFileByFileIdAsync( 
        fileId="path/to/file/name"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
fileId	str	yes	Combination of `path` and `name` of file

Returned Response:

FilesResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

updateFile

Summary: Update file details

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.updateFile( 
        fileId="path/to/file/name",
        name="asset", 
        path="dir", 
        access="private", 
        isActive=False, 
        tags=["tag1","tag2"], 
        metadata={"key":"value"})
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.updateFileAsync( 
        fileId="path/to/file/name",
        name="asset", 
        path="dir", 
        access="private", 
        isActive=False, 
        tags=["tag1","tag2"], 
        metadata={"key":"value"}))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
fileId	str	yes	Combination of `path` and `name`
name	str	no	Name of the file
path	str	no	Path of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
isActive	bool	no	Whether the file is active
tags	List[str]	no	Tags associated with the file
metadata	Any	no	Metadata associated with the file

Returned Response:

FilesResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

deleteFile

Summary: Delete file

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.deleteFile( 
        fileId="path/to/file/name")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.deleteFileAsync( 
        fileId="path/to/file/name"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
fileId	str	yes	Combination of `path` and `name`

Returned Response:

FilesResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

deleteFiles

Summary: Delete multiple files

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.deleteFiles(
        ids=["_id_1","_id_2","_id_3"])
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.deleteFilesAsync(
        ids=["_id_1","_id_2","_id_3"]))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
ids	List[str]	yes	Array of file _ids to delete

Returned Response:

List[FilesResponse]

Success

Example:

[
  {
    "_id": "dummy-uuid",
    "name": "asset",
    "path": "dir",
    "fileId": "dir/asset",
    "format": "jpeg",
    "size": 1000,
    "access": "private",
    "isActive": true,
    "tags": [
      "tag1",
      "tag2"
    ],
    "metadata": {
      "key": "value"
    },
    "url": "https://domain.com/filename.jpeg"
  }
]

createFolder

Summary: Create folder

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.createFolder(
        name="subDir", 
        path="dir")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.createFolderAsync(
        name="subDir", 
        path="dir"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
name	str	yes	Name of the folder
path	str	no	Path of the folder

Create a new folder at the specified path. Also creates the ancestors if they do not exist.

Returned Response:

FoldersResponse

Success - List of all created folders

Example:

{
  "_id": "dummy-uuid",
  "name": "subDir",
  "path": "dir",
  "isActive": true
}

getFolderDetails

Summary: Get folder details

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getFolderDetails( 
        path="dir1/dir2", 
        name="dir")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getFolderDetailsAsync( 
        path="dir1/dir2", 
        name="dir"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
path	str	no	Folder path
name	str	no	Folder name

Get folder details

Returned Response:

exploreItem

Success

Example:

[
  {
    "_id": "dummy-uuid",
    "createdAt": "2022-10-05T10:43:04.117Z",
    "updatedAt": "2022-10-05T10:43:04.117Z",
    "name": "asset2",
    "type": "file",
    "path": "dir",
    "fileId": "dir/asset2",
    "format": "jpeg",
    "size": 1000,
    "access": "private",
    "metadata": {},
    "height": 100,
    "width": 100
  }
]

updateFolder

Summary: Update folder details

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.updateFolder( 
        folderId="path/to/folder/name",
        isActive=False)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.updateFolderAsync( 
        folderId="path/to/folder/name",
        isActive=False))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
folderId	str	yes	combination of `path` and `name`
isActive	bool	no	whether the folder is active

Update folder details. Eg: Soft delete it by making isActive as false. We currently do not support updating folder name or path.

Returned Response:

FoldersResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "subDir",
  "path": "dir",
  "isActive": true
}

deleteFolder

Summary: Delete folder

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.deleteFolder( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.deleteFolderAsync( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
id	str	yes	_id of folder to be deleted

Delete folder and all its children permanently.

Returned Response:

FoldersResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "subDir",
  "path": "dir",
  "isActive": true
}

getFolderAncestors

Summary: Get all ancestors of a folder

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getFolderAncestors( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getFolderAncestorsAsync( 
        _id="c9138153-94ea-4dbe-bea9-65d43dba85ae"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
id	str	yes	_id of the folder

Get all ancestors of a folder, using the folder ID.

Returned Response:

GetAncestorsResponse

Success

Example:

{
  "folder": {
    "_id": "dummy-uuid",
    "name": "subDir",
    "path": "dir1/dir2",
    "isActive": true
  },
  "ancestors": [
    {
      "_id": "dummy-uuid-2",
      "name": "dir1",
      "path": "",
      "isActive": true
    },
    {
      "_id": "dummy-uuid-2",
      "name": "dir2",
      "path": "dir1",
      "isActive": true
    }
  ]
}

listFiles

Summary: List and search files and folders.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.listFiles( 
        name="cat", 
        path="cat-photos", 
        format="jpeg", 
        tags=["cats","animals"], 
        onlyFiles="false", 
        onlyFolders="false", 
        pageNo=1, 
        pageSize=10, 
        sort="name")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.listFilesAsync( 
        name="cat", 
        path="cat-photos", 
        format="jpeg", 
        tags=["cats","animals"], 
        onlyFiles="false", 
        onlyFolders="false", 
        pageNo=1, 
        pageSize=10, 
        sort="name"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
name	str	no	Find items with matching name
path	str	no	Find items with matching path
format	str	no	Find items with matching format
tags	List[str]	no	Find items containing these tags
onlyFiles	bool	no	If true will fetch only files
onlyFolders	bool	no	If true will fetch only folders
pageNo	int	no	Page No.
pageSize	int	no	Page Size
sort	str	no	Key to sort results by. A "-" suffix will sort results in descending orders.

List all files and folders in root folder. Search for files if name is provided. If path is provided, search in the specified path.

Returned Response:

ListFilesResponse

Success

Example:

{
  "items": [
    {
      "_id": "dummy-uuid",
      "name": "dir",
      "type": "folder"
    },
    {
      "_id": "dummy-uuid",
      "name": "asset2",
      "type": "file",
      "path": "dir",
      "fileId": "dir/asset2",
      "format": "jpeg",
      "size": 1000,
      "access": "private"
    },
    {
      "_id": "dummy-uuid",
      "name": "asset1",
      "type": "file",
      "path": "dir",
      "fileId": "dir/asset1",
      "format": "jpeg",
      "size": 1000,
      "access": "private"
    }
  ],
  "page": {
    "type": "number",
    "size": 4,
    "current": 1,
    "hasNext": false
  }
}

getDefaultAssetForPlayground

Summary: Get default asset for playground

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getDefaultAssetForPlayground()
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getDefaultAssetForPlaygroundAsync())
    # use result
except Exception as e:
    print(e)

Get default asset for playground

Returned Response:

UploadResponse

Success

Example:

{
  "isActive": true,
  "orgId": "1",
  "type": "file",
  "name": "abc.jpeg",
  "path": "/xyz",
  "fileId": "xyz/abc.jpeg",
  "format": "jpeg",
  "size": 100,
  "tags": null,
  "metadata": null,
  "access": "public-read",
  "width": null,
  "height": null,
  "meta": {},
  "context": null,
  "assetType": null,
  "isOriginal": true,
  "_id": "35675e3a-5dd8-4b19-a611-1cb64e676c5e",
  "url": "https://cdn.pixelbin.io/v2/dummy-cloudname/original/xyz/abc.jpeg"
}

getModules

Summary: Get all transformation modules

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getModules()
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getModulesAsync())
    # use result
except Exception as e:
    print(e)

Get all transformation modules.

Returned Response:

TransformationModulesResponse

Success

Example:

{
  "delimiters": {
    "operationSeparator": "~",
    "parameterSeparator": ":"
  },
  "plugins": {
    "erase": {
      "identifier": "erase",
      "name": "EraseBG",
      "description": "EraseBG Background Removal Module",
      "credentials": {
        "required": false
      },
      "operations": [
        {
          "params": {
            "name": "Industry Type",
            "type": "enum",
            "enum": [
              "general",
              "ecommerce"
            ],
            "default": "general",
            "identifier": "i",
            "title": "Industry type"
          },
          "displayName": "Remove background of an image",
          "method": "bg",
          "description": "Remove the background of any image"
        }
      ],
      "enabled": true
    }
  },
  "presets": [
    {
      "_id": "dummy-id",
      "createdAt": "2022-02-14T10:06:17.803Z",
      "updatedAt": "2022-02-14T10:06:17.803Z",
      "isActive": true,
      "orgId": "265",
      "presetName": "compressor",
      "transformation": "t.compress(q:95)",
      "archived": false
    }
  ]
}

getModule

Summary: Get Transformation Module by module identifier

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getModule( 
        identifier="t")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getModuleAsync( 
        identifier="t"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
identifier	str	yes	identifier of Transformation Module

Get Transformation Module by module identifier

Returned Response:

TransformationModuleResponse

Success

Example:

{
  "identifier": "erase",
  "name": "EraseBG",
  "description": "EraseBG Background Removal Module",
  "credentials": {
    "required": false
  },
  "operations": [
    {
      "params": {
        "name": "Industry Type",
        "type": "enum",
        "enum": [
          "general",
          "ecommerce"
        ],
        "default": "general",
        "identifier": "i",
        "title": "Industry type"
      },
      "displayName": "Remove background of an image",
      "method": "bg",
      "description": "Remove the background of any image"
    }
  ],
  "enabled": true
}

addPreset

Summary: Add a preset.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.addPreset(
        presetName="pre-set_1", 
        transformation="t.resize(w:$w,h:$h)~t.extract()", 
        params={"w":{"type":"integer","default":200},"h":{"type":"integer","default":400}})
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.addPresetAsync(
        presetName="pre-set_1", 
        transformation="t.resize(w:$w,h:$h)~t.extract()", 
        params={"w":{"type":"integer","default":200},"h":{"type":"integer","default":400}}))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
presetName	str	yes	Name of the preset
transformation	str	yes	A chain of transformations, separated by `~`
params	Any	no	Parameters object for transformation variables

Add a preset for an organization.

Returned Response:

AddPresetResponse

Success

Example:

{
  "orgId": 23,
  "presetName": "pre-set_1",
  "transformation": "t.resize(w:$w,h:$h)~t.extract()",
  "params": {
    "w": {
      "type": "integer",
      "default": 200
    },
    "h": {
      "type": "integer",
      "default": 400
    }
  },
  "_id": "821c6816-3cbb-40fd-8629-0098007fc949",
  "createdAt": "2024-03-21T10:35:47.822Z",
  "updatedAt": "2024-03-21T10:35:47.822Z",
  "isActive": true,
  "archived": false
}

getPresets

Summary: Get presets for an organization

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getPresets( 
        pageNo=1, 
        pageSize=5, 
        name="t_0", 
        transformation="t.resize(a:0)", 
        archived="false", 
        sort=["updatedAt"])
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getPresetsAsync( 
        pageNo=1, 
        pageSize=5, 
        name="t_0", 
        transformation="t.resize(a:0)", 
        archived="false", 
        sort=["updatedAt"]))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
pageNo	int	no	Page number
pageSize	int	no	Page size
name	str	no	Preset name
transformation	str	no	Transformation applied
archived	bool	no	Indicates whether the preset is archived or not
sort	List[str]	no	Sort the results by a specific key

Retrieve presets for a specific organization.

Returned Response:

GetPresetsResponse

Success

Example:

{
  "items": [
    {
      "_id": "f1ae2fc0-a931-4cef-bd1a-3644dad5ae9b",
      "createdAt": "2024-03-21T10:45:06.623Z",
      "updatedAt": "2024-03-21T10:45:06.623Z",
      "isActive": true,
      "orgId": 23,
      "presetName": "t_0",
      "transformation": "t.resize(a:0)",
      "archived": false,
      "params": {}
    },
    {
      "_id": "b40a03f1-7fa5-42b1-8cc6-ffe84c9e6629",
      "createdAt": "2024-03-21T10:45:06.637Z",
      "updatedAt": "2024-03-21T10:45:06.637Z",
      "isActive": true,
      "orgId": 23,
      "presetName": "t_1",
      "transformation": "t.resize(a:1)",
      "archived": false,
      "params": {}
    }
  ],
  "page": {
    "type": "number",
    "size": 2,
    "current": 1,
    "hasNext": true,
    "itemTotal": 10
  }
}

updatePreset

Summary: Update a preset.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.updatePreset( 
        presetName="p1",
        archived=True)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.updatePresetAsync( 
        presetName="p1",
        archived=True))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
presetName	str	yes	Name of the preset to be updated
archived	bool	yes	Indicates if the preset has been archived

Update a preset of an organization.

Returned Response:

AddPresetResponse

Success

Example:

{
  "orgId": 23,
  "presetName": "pre-set_1",
  "transformation": "t.resize(w:$w,h:$h)~t.extract()",
  "params": {
    "w": {
      "type": "integer",
      "default": 200
    },
    "h": {
      "type": "integer",
      "default": 400
    }
  },
  "_id": "821c6816-3cbb-40fd-8629-0098007fc949",
  "createdAt": "2024-03-21T10:35:47.822Z",
  "updatedAt": "2024-03-21T10:35:47.822Z",
  "isActive": true,
  "archived": true
}

deletePreset

Summary: Delete a preset.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.deletePreset( 
        presetName="pre-set_1")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.deletePresetAsync( 
        presetName="pre-set_1"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
presetName	str	yes	Name of the preset to be deleted

Delete a preset of an organization.

Returned Response:

AddPresetResponse

Success

Example:

{
  "orgId": 23,
  "presetName": "pre-set_1",
  "transformation": "t.resize(w:$w,h:$h)~t.extract()",
  "params": {
    "w": {
      "type": "integer",
      "default": 200
    },
    "h": {
      "type": "integer",
      "default": 400
    }
  },
  "_id": "821c6816-3cbb-40fd-8629-0098007fc949",
  "createdAt": "2024-03-21T10:35:47.822Z",
  "updatedAt": "2024-03-21T10:35:47.822Z",
  "isActive": true,
  "archived": false
}

getPreset

Summary: Get a preset.

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.getPreset( 
        presetName="p1")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.getPresetAsync( 
        presetName="p1"))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
presetName	str	yes	Name of the preset to be fetched

Get a preset of an organization.

Returned Response:

AddPresetResponse

Success

Example:

{
  "orgId": 23,
  "presetName": "p1",
  "transformation": "t.resize(w:$w,h:$h)~t.extract()",
  "params": {
    "w": {
      "type": "integer",
      "default": 200
    },
    "h": {
      "type": "integer",
      "default": 400
    }
  },
  "_id": "821c6816-3cbb-40fd-8629-0098007fc949",
  "createdAt": "2024-03-21T10:35:47.822Z",
  "updatedAt": "2024-03-21T10:35:47.822Z",
  "isActive": true,
  "archived": false
}

fileUpload

Summary: Upload File

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.fileUpload(
        file=open("your-file-path", "rb"), 
        path="path/to/containing/folder", 
        name="filename", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.fileUploadAsync(
        file=open("your-file-path", "rb"), 
        path="path/to/containing/folder", 
        name="filename", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
file	FileIO	yes	Asset file
path	str	no	Path where you want to store the asset
name	str	no	Name of the asset, if not provided name of the file will be used. Note - The provided name will be slugified to make it URL safe
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Asset tags
metadata	Any	no	Asset related metadata
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

Upload File to Pixelbin

Returned Response:

UploadResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

urlUpload

Summary: Upload Asset with url

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.urlUpload(
        url="www.dummy.com/image.png", 
        path="path/to/containing/folder", 
        name="filename", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.urlUploadAsync(
        url="www.dummy.com/image.png", 
        path="path/to/containing/folder", 
        name="filename", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
url	str	yes	Asset URL
path	str	no	Path where you want to store the asset
name	str	no	Name of the asset, if not provided name of the file will be used. Note - The provided name will be slugified to make it URL safe
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Asset tags
metadata	Any	no	Asset related metadata
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

Upload Asset with url

Returned Response:

UploadResponse

Success

Example:

{
  "_id": "dummy-uuid",
  "name": "asset",
  "path": "dir",
  "fileId": "dir/asset",
  "format": "jpeg",
  "size": 1000,
  "access": "private",
  "isActive": true,
  "tags": [
    "tag1",
    "tag2"
  ],
  "metadata": {
    "key": "value"
  },
  "url": "https://domain.com/filename.jpeg"
}

createSignedUrl

Summary: S3 Signed URL upload

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.createSignedUrl(
        name="filename", 
        path="path/to/containing/folder", 
        format="jpeg", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.createSignedUrlAsync(
        name="filename", 
        path="path/to/containing/folder", 
        format="jpeg", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
name	str	no	name of the file
path	str	no	Path of the file
format	str	no	Format of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Tags associated with the file.
metadata	Any	no	Metadata associated with the file.
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

For the given asset details, a S3 signed URL will be generated, which can be then used to upload your asset.

Returned Response:

SignedUploadResponse

Success

Example:

{
  "s3PresignedUrl": {
    "url": "https://domain.com/xyz",
    "fields": {
      "field1": "value",
      "field2": "value"
    }
  }
}

createSignedUrlV2

Summary: Signed multipart upload

import asyncio
from pixelbin import PixelbinClient, PixelbinConfig

config = PixelbinConfig({
    "domain": "https://api.pixelbin.io",
    "apiSecret": "API_SECRECT_TOKEN",
})

pixelbin:PixelbinClient = PixelbinClient(config=config)

# Sync method call
try:
    result = pixelbin.assets.createSignedUrlV2(
        name="filename", 
        path="path/to/containing/folder", 
        format="jpeg", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True, 
        expiry=3000)
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.assets.createSignedUrlV2Async(
        name="filename", 
        path="path/to/containing/folder", 
        format="jpeg", 
        access="public-read", 
        tags=["tag1","tag2"], 
        metadata={}, 
        overwrite=False, 
        filenameOverride=True, 
        expiry=3000))
    # use result
except Exception as e:
    print(e)

Argument	Type	Required	Description
name	str	no	name of the file
path	str	no	Path of containing folder.
format	str	no	Format of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Tags associated with the file.
metadata	Any	no	Metadata associated with the file.
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.
expiry	int	no	Expiry time in seconds for the signed URL. Defaults to 3000 seconds.

For the given asset details, a presigned URL will be generated, which can be then used to upload your asset in chunks via multipart upload.

Returned Response:

SignedUploadV2Response

Success

Example:

{
  "presignedUrl": {
    "url": "https://api.pixelbin.io/service/public/assets/v1.0/signed-multipart?pbs=8b49e6cdd446be379aa4396e1a&pbe=1700600070390&pbt=92661&pbo=143209&pbu=5fe187e8-8649-4546-9a28-ff551839e0f5",
    "fields": {
      "x-pixb-meta-assetdata": "{\"orgId\":1,\"type\":\"file\",\"name\":\"filename.jpeg\",\"path\":\"\",\"fileId\":\"filename.jpeg\",\"format\":\"jpeg\",\"s3Bucket\":\"erase-erase-erasebg-assets\",\"s3Key\":\"uploads/floral-sun-9617c8/original/a34f1d3-28bf-489c-9aff-cc549ac9e003.jpeg\",\"access\":\"public-read\",\"tags\":[],\"metadata\":{\"source\":\"signedUrl\",\"publicUploadId\":\"5fe187e8-8649-4546-9a28-ff551839e0f5\"},\"overwrite\":false,\"filenameOverride\":false}"
    }
  }
}

Schemas

folderItem

Properties	Type	Nullable	Description
_id	str	no	Id of the folder item
orgId	int	no	Organization Id
name	str	no	Name of the folder item
path	str	no	Path of the folder item
type	str	no	Type of the item. `file` or `folder`

exploreItem

Properties	Type	Nullable	Description
_id	str	no	id of the exploreItem
orgId	int	no	Organization Id
name	str	no	name of the item
type	str	no	Type of item whether `file` or `folder`
path	str	no	Path of the folder item
fileId	str	no	FileId associated with the item. `path`+`name`
format	str	no	Format of the file
size	int	no	Size of the file in bytes
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
s3Bucket	str	no	Bucket Name
s3Key	str	no	s3 path of file

page

Properties	Type	Nullable	Description
type	str	yes	Type of page
size	int	yes	Number of items on the page
current	int	yes	Current page number.
hasNext	bool	yes	Whether the next page exists.
itemTotal	int	yes	Total number of items.

exploreResponse

Properties	Type	Nullable	Description
items	List[exploreItem]	yes	exploreItems in current page
page	page	yes	page details

ListFilesResponse

Properties	Type	Nullable	Description
items	List[exploreItem]	no	exploreItems in current page
page	page	no	page details

FileUploadRequest

Properties	Type	Nullable	Description
file	FileIO	yes	Asset file
path	str	no	Path where you want to store the asset
name	str	no	Name of the asset, if not provided name of the file will be used. Note - The provided name will be slugified to make it URL safe
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Asset tags
metadata	Any	no	Asset related metadata
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

UrlUploadRequest

Properties	Type	Nullable	Description
url	str	yes	Asset URL
path	str	no	Path where you want to store the asset
name	str	no	Name of the asset, if not provided name of the file will be used. Note - The provided name will be slugified to make it URL safe
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Asset tags
metadata	Any	no	Asset related metadata
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

UploadResponse

Properties	Type	Nullable	Description
_id	str	yes	_id of the item
fileId	str	yes	FileId associated with the item. path+name
name	str	yes	name of the item
path	str	yes	path to the parent folder
format	str	yes	format of the file
size	int	yes	size of file in bytes
access	AccessEnum	yes	Access level of asset, can be either public-read or private
tags	List[str]	no	tags associated with the item
metadata	Any	no	metadata associated with the item
url	str	no	url of the item
thumbnail	str	no	url of item thumbnail

SignedUploadRequest

Properties	Type	Nullable	Description
name	str	no	name of the file
path	str	no	Path of the file
format	str	no	Format of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Tags associated with the file.
metadata	Any	no	Metadata associated with the file.
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.

SignedUploadResponse

Properties	Type	Nullable	Description
s3PresignedUrl	PresignedUrl	yes	`signedDetails` for upload with frontend sdk

PresignedUrl

Properties	Type	Nullable	Description
url	str	no	`presigned url` for upload

| | fields | Any | no | signed fields to be sent along with request |

FilesResponse

Properties	Type	Nullable	Description
_id	str	yes	_id of the file
name	str	yes	name of the file
path	str	yes	path to the parent folder of the file
fileId	str	yes	FileId associated with the item. `path`+`name`
format	str	yes	format of the file
size	int	yes	size of the file in bytes
access	AccessEnum	yes	Access level of file, can be either `public-read` or `private`
isActive	bool	yes	Whether the file is active
tags	List[str]	no	Tags associated with the file
metadata	Any	no	Metadata associated with the file
url	str	no	url of the file
thumbnail	str	no	url of the thumbnail of the file

UpdateFileRequest

Properties	Type	Nullable	Description
name	str	no	Name of the file
path	str	no	Path of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
isActive	bool	no	Whether the file is active
tags	List[str]	no	Tags associated with the file
metadata	Any	no	Metadata associated with the file

FoldersResponse

Properties	Type	Nullable	Description
_id	str	yes	_id of the folder
name	str	yes	name of the folder
path	str	yes	path to the parent folder of the folder
isActive	bool	yes	whether the folder is active

CreateFolderRequest

Properties	Type	Nullable	Description
name	str	yes	Name of the folder
path	str	no	Path of the folder

UpdateFolderRequest

Properties	Type	Nullable	Description
isActive	bool	no	whether the folder is active

DeleteMultipleFilesRequest

Properties	Type	Nullable	Description
ids	List[str]	yes	Array of file _ids to delete

Delimiter

Properties	Type	Nullable	Description
operationSeparator	str	no	separator to separate operations in the url pattern
parameterSeparator	str	no	separator to separate parameters used with operations in the url pattern

AddCredentialsRequest

Properties	Type	Nullable	Description
credentials	Any	yes	Credentials of the plugin
pluginId	str	yes	Unique identifier for the plugin this credential belongs to

UpdateCredentialsRequest

Properties	Type	Nullable	Description
credentials	Any	yes	Credentials of the plugin

AddCredentialsResponse

Properties	Type	Nullable	Description
credentials	Any	no

GetAncestorsResponse

Properties	Type	Nullable	Description
folder	folderItem	no
ancestors	List[FoldersResponse]	no

AddPresetRequest

Properties	Type	Nullable	Description
presetName	str	yes	Name of the preset
transformation	str	yes	A chain of transformations, separated by `~`
params	Any	no	Parameters object for transformation variables

AddPresetResponse

Properties	Type	Nullable	Description
presetName	str	no	Name of the preset
transformation	str	no	A chain of transformations, separated by `~`
params	Any	no	Parameters object for transformation variables
archived	bool	no	Indicates if the preset has been archived
orgId	int	no	Organization Id
isActive	bool	no	Indicates if the preset is active
createdAt	str	no	Preset creation ISO timestamp
updatedAt	str	no	Preset update ISO timestamp

UpdatePresetRequest

Properties	Type	Nullable	Description
archived	bool	yes	Indicates if the preset has been archived

GetPresetsResponse

Properties	Type	Nullable	Description
items	List[AddPresetResponse]	yes
page	page	yes	page details

TransformationModuleResponse

Properties	Type	Nullable	Description
identifier	str	no	identifier for the plugin type
name	str	no	name of the plugin
description	str	no	description of the plugin
credentials	Any	no	credentials, if any, associated with the plugin
operations	List[Any]	no	supported operations in the plugin
enabled	bool	no	whether the plugin is enabled

TransformationModulesResponse

Properties	Type	Nullable	Description
delimiters	Delimiter	no	Delimiter for parsing plugin schema
plugins	Any	no	Transformations currently supported by the pixelbin
presets	List[Any]	no	List of saved presets

SignedUploadRequestV2

Properties	Type	Nullable	Description
name	str	no	name of the file
path	str	no	Path of containing folder.
format	str	no	Format of the file
access	AccessEnum	no	Access level of asset, can be either `public-read` or `private`
tags	List[str]	no	Tags associated with the file.
metadata	Any	no	Metadata associated with the file.
overwrite	bool	no	Overwrite flag. If set to `true` will overwrite any file that exists with same path, name and type. Defaults to `false`.
filenameOverride	bool	no	If set to `true` will add unique characters to name if asset with given name already exists. If overwrite flag is set to `true`, preference will be given to overwrite flag. If both are set to `false` an error will be raised.
expiry	int	no	Expiry time in seconds for the signed URL. Defaults to 3000 seconds.

SignedUploadV2Response

Properties	Type	Nullable	Description
presignedUrl	PresignedUrlV2	yes	Presigned URL for uploading asset in chunks

PresignedUrlV2

Properties	Type	Nullable	Description
url	str	no	Presigned URL for uploading asset in chunks
fields	Any	no	signed fields to be sent along with request

Enums

AccessEnum

Type : string

Name	Value	Description
public-read	public-read	public-read
private	private	private

FilesExpand file tree

ASSETS.md

Latest commit

History

ASSETS.md

File metadata and controls

Back to Pixelbin API docs

Assets Methods

Methods with example and description

addCredentials

updateCredentials

deleteCredentials

getFileById

getFileByFileId

updateFile

deleteFile

deleteFiles

createFolder

getFolderDetails

updateFolder

deleteFolder

getFolderAncestors

listFiles

getDefaultAssetForPlayground

getModules

getModule

addPreset

getPresets

updatePreset

deletePreset

getPreset

fileUpload

urlUpload

createSignedUrl

createSignedUrlV2

Schemas

folderItem

exploreItem

page

exploreResponse

ListFilesResponse

FileUploadRequest

UrlUploadRequest

UploadResponse

SignedUploadRequest

SignedUploadResponse

PresignedUrl

FilesResponse

UpdateFileRequest

FoldersResponse

CreateFolderRequest

UpdateFolderRequest

DeleteMultipleFilesRequest

Delimiter

AddCredentialsRequest

UpdateCredentialsRequest

AddCredentialsResponse

GetAncestorsResponse

AddPresetRequest

AddPresetResponse

UpdatePresetRequest

GetPresetsResponse

TransformationModuleResponse

TransformationModulesResponse

SignedUploadRequestV2

SignedUploadV2Response

PresignedUrlV2

Enums

AccessEnum