Pebblely API Documentation

https://api.pebblely.com/{endpoint}

Response:    # "credits" - Number of credits remaining    credits: int

import requestsendpoint_url = "https://api.pebblely.com/credits/v1/"response = requests.get(    endpoint_url,    headers={        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },)remaining_credits = response.json()["credits"]

Response:    # List of Theme objects, where each object comprises the following keys and values    #   "label": str - Label of theme    #   "thumbnail": str - Sample thumbnail URL    List[Dict[str, str]]

import requestsendpoint_url = "https://api.pebblely.com/themes/v1/"response = requests.get(    endpoint_url)themes = response.json()print(len(themes)) # Should print number of themesprint(themes[0]["label"]) # Should print "Surprise me"

RequestBody:    # "images" - A list of strings, which are Base64 representations or URLs of images    images: List[str]    # "theme" - One of our 40+ themes. Use our free Get Themes endpoint to retrieve the full list.    # This is ignored if `description` is supplied    theme: str = "Surprise me"    # "description" - Custom description of the created image    description: str = ""    # "style_color" - Hex string representing a color e.g. "#FFFFFF"    style_color: str = None    # "style_image" - Base64 representation or URL of image    style_image: str = None    # "negative" - A list of comma-separated attributes that should be discouraged from the image    negative: str = ""    # "generate_plus" - Whether to use the Generate+ pipeline, which takes longer (~15s) with better quality    generate_plus: bool = False    # "transforms" - A List of Dicts that has the following parameters (all optional):    #   - "scale_x": float - Scale the product image horizontally    #   - "scale_Y": float - Scale the product image vertically    #   - "x": int - Translate the product image vertically    #   - "y": int - Translate the product image vertically    #   - "angle": float - Rotate the product clockwise, in degrees    # If no "transforms" is provided or is an empty List, the product images default to being centered in the 512 x 512 canvas    transforms: List[Dict] = []    # "autoresize" - Use this parameter to automatically resize and center your input image to fit the resulting output    autoresize: bool = False    # "height", "width" - Height and width of image, up to a maximum of 2048    # If only one dimension is provided, the other dimension defaults to the same value and a square image will be generated    height: int = 512    width: int = 512

Response:    # "data" - Base64 representation of the resulting image    data: str    # "credits" - Number of remaining credits    credits: int

import base64import ioimport requestsfrom PIL import Imageendpoint_url = "https://api.pebblely.com/create-background/v2/"response = requests.post(    endpoint_url,    headers={        "Content-Type": "application/json",        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },    json={        "images": ["<YOUR IMAGE URL OR BASE64>"],        "theme": "Surprise me",        "transforms": [{            "scale_x": 1,            "scale_y": 1,            "x": 0,            "y": 0,            "angle": 0        }]    })# Process Base64 output and save locally image_b64 = response.json()["data"]image_encoded = image_b64.encode("utf-8")image_bytes = io.BytesIO(base64.b64decode(image_encoded))image = Image.open(image_bytes)image.save("image.jpg")

RequestBody:    # "image" - Base64 representation or URL of image    image: str

Response:    # "data" - Base64 representation of the resulting image    data: str    # "credits" - Number of remaining credits    credits: int

import base64import ioimport requestsfrom PIL import Imageendpoint_url = "https://api.pebblely.com/remove-background/v1/"response = requests.post(    endpoint_url,    headers={        "Content-Type": "application/json",        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },    json={        "image": "<YOUR IMAGE URL OR BASE64>",    })image_b64 = response.json()["data"]image_encoded = image_b64.encode("utf-8")image_bytes = io.BytesIO(base64.b64decode(image_encoded))image = Image.open(image_bytes)image.save("image.png")

RequestBody:    # "image" - Base64 representation or URL of image    image: str    # "size" - Size of the image, one of [1024, 2048]    size: int = 1024

Response:    # "data" - Base64 representation of the resulting image    data: str    # "credits" - Number of remaining credits    credits: int

import base64import ioimport requestsfrom PIL import Imageendpoint_url = "https://api.pebblely.com/upscale/v1/"response = requests.post(    endpoint_url,    headers={        "Content-Type": "application/json",        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },    json={        "image": "<YOUR IMAGE URL OR BASE64>",        "size": 1024,    })image_b64 = response.json()["data"]image_encoded = image_b64.encode("utf-8")image_bytes = io.BytesIO(base64.b64decode(image_encoded))image = Image.open(image_bytes)image.save("image.jpg")

RequestBody:    # "image" - Base64 representation or URL of image    image: str    # "width" and "height" - Size of the image, up to a maxium of 2048    # If only one dimension is provided, the output will be a square image of that size    width: int = 512    height: int = 512    # "transform": - A dictionary or object that has the following parameters (all optional):    # If no "transform" is provided or is None, the product defaults to being centered in the canvas    transform = {        # "scale_x" - Scale the image horizontally        scale_x: float = 1.0,        # "scale_y" - Scale the image vertically        scale_y: float = 1.0,        # "x" - Translate the image horizontally        x: int = 0,        # "y" - Translate the image vertically        y: int = 0,        # "angle" - Rotate the image clockwise, in degrees        angle: float = 0.0,    }    # If the input image was generated using the `create-background` endpoint, we recommend providing the same settings below    # "theme" - One of ["Surprise me", "Studio", "Outdoors", "Silk", "Cafe", "Tabletop", "Kitchen", "Flowers", "Nature", "Beach", "Bathroom", "Furniture", "Paint", "Fruits", "Water", "Pebbles", "Snow"]    # This is ignored if `description` is supplied    theme: str = "Surprise me"    # "description" - Custom description of the created image    description: str = ""    # "style_color" - Hex string representing a color e.g. "#FFFFFF"    style_color: str = None    # "style_image" - Base64 representation or URL of image    style_image: str = None    # "negative" - A list of comma-separated attributes that should be discouraged from the image    negative: str = ""

Response:    # "data" - Base64 representation of the resulting image    data: str    # "credits" - Number of remaining credits    credits: int

import base64import ioimport requestsfrom PIL import Imageendpoint_url = "https://api.pebblely.com/outpaint/v1/"response = requests.post(    endpoint_url,    headers={        "Content-Type": "application/json",        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },    json={        "image": "<YOUR IMAGE URL OR BASE64>",        "width": 1024,    })image_b64 = response.json()["data"]image_encoded = image_b64.encode("utf-8")image_bytes = io.BytesIO(base64.b64decode(image_encoded))image = Image.open(image_bytes)image.save("image.jpg")

RequestBody:    # "image" - Base64 representation or URL of image    image: str    # "mask" - Base64 representation or URL of binary mask, where non-zero values indicate sections to be inpainted - must be same dimensions as image    mask: str    # If the original image was generated using the `create-background` endpoint, we recommend providing the same settings below    # "theme" - One of ["Surprise me", "Studio", "Outdoors", "Silk", "Cafe", "Tabletop", "Kitchen", "Flowers", "Nature", "Beach", "Bathroom", "Furniture", "Paint", "Fruits", "Water", "Pebbles", "Snow"]    # This is ignored if `description` is supplied    theme: str = "Surprise me"    # "description" - Custom description of the created image    description: str = ""    # "style_color" - Hex string representing a color e.g. "#FFFFFF"    style_color: str = None    # "style_image" - Base64 representation or URL of image    style_image: str = None    # "negative" - A list of comma-separated attributes that should be discouraged from the image    negative: str = ""

Response:    # "data" - Base64 representation of the resulting image    data: str    # "credits" - Number of remaining credits    credits: int

import base64import ioimport requestsfrom PIL import Imageendpoint_url = "https://api.pebblely.com/inpaint/v1/"response = requests.post(    endpoint_url,    headers={        "Content-Type": "application/json",        "X-Pebblely-Access-Token": "<YOUR ACCESS TOKEN>",    },    json={        "image": "<YOUR IMAGE URL OR BASE64>",        "mask": "<YOUR MASK URL OR BASE64>",    })image_b64 = response.json()["data"]image_encoded = image_b64.encode("utf-8")image_bytes = io.BytesIO(base64.b64decode(image_encoded))image = Image.open(image_bytes)image.save("image.jpg")