Skip to content

Latest commit

 

History

History
165 lines (102 loc) · 2.91 KB

TRANSFORMATION.md

File metadata and controls

165 lines (102 loc) · 2.91 KB
Back to Pixelbin API docs

Transformation Methods

Image Transformation Service

Methods with example and description

getTransformationContext

Summary: Get transformation context

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.transformation.getTransformationContext( 
        url="/v2/fynd-eg/t.resize()/__playground/playground-default.jpeg")
    # use result
except Exception as e:
    print(e)

# Async method call
try:
    result = asyncio.run(pixelbin.transformation.getTransformationContextAsync( 
        url="/v2/fynd-eg/t.resize()/__playground/playground-default.jpeg"))
    # use result
except Exception as e:
    print(e)
Argument Type Required Description
url str no CDN URL with transformation.

Get transformation context

Returned Response:

GetTransformationContextSuccessResponse

Success

  Examples:
  GetTransformationContextSuccessResponse 
{
  "value": {
    "context": {
      "steps": [
        {
          "name": "blur",
          "operation": "Basic",
          "identifier": "t",
          "data": {},
          "metadata": null,
          "format": "jpeg",
          "size": 58650,
          "width": 1140,
          "height": 760,
          "space": "srgb",
          "channels": 3,
          "depth": "uchar",
          "density": 72,
          "chromaSubsampling": "4:2:0",
          "isProgressive": false,
          "resolutionUnit": "inch",
          "hasProfile": false,
          "hasAlpha": false,
          "orientation": 1
        }
      ],
      "metadata": {
        "width": 1140,
        "height": 760,
        "channels": 3,
        "extension": "jpeg",
        "format": "jpeg",
        "contentType": "image/jpeg",
        "size": 62667,
        "assetType": "image",
        "isImageAsset": true,
        "isAudioAsset": false,
        "isVideoAsset": false,
        "isRawAsset": false
      },
      "headers": {
        "host": "api.pixelbin.io",
        "x-real-ip": "0.0.0.0",
        "origin": "https://console.pixelbin.io",
        "accept": "application/json, text/plain, */*",
        "accept-encoding": "gzip, deflate, br",
        "accept-language": "en-US,en;q=0.9"
      },
      "params": {}
    }
  }
}

Schemas

GetTransformationContextSuccessResponse

Properties Type Nullable Description
context Any no