BORDER3D API Endpoint

Version 2.197 (Release Notes ↗)

Description

Generate a simulated 3D border around images with BORDER3D. Customize border width, height, and inner/outer bevels for a realistic frame effect. Perfect for developers and creators looking to enhance visual content. Generate a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame.

HTTP Methods

GET, POST

HTTP Parameters

Required

Fields Type Description
img URL Input image URL. If uploading directly from your app, submit a multipart/form-data POST request.
width Integer Border width (Max: 300).
height Integer Border height (Max: 300).
inner Integer Inner bevel width (Max: 50).
outer Integer Outer bevel width (Max: 50).
color String Color name (red, blue, etc) or hex code (#fffeec, #e45cff).
key String Your PixLab API Key ↗. Can also be passed via WWW-Authenticate: header.

Optional

Fields Type Description
blob Boolean Returns image binary instead of JSON when true.

POST Request Body

Use when submitting via POST instead of GET:

Allowed Content-Types:

  • multipart/form-data
  • application/json

Use multipart/form-data for direct image uploads (see samples). For JSON, image must be pre-uploaded (use store endpoint first).

HTTP Response

The API returns application/json if the optional blob parameter is not set.

This endpoint returns a JSON Object after each call only if the optional blob parameter is not set. Otherwise, the image binary contents are returned instead. The following are the JSON fields returned in the response body:

Fields Type Description
status Integer Status code 200 indicates success, any other code indicates failure.
link URL Link to the image output which is usually stored on the pixlab.xyz storage server unless you set your own S3 keys (refer to your dashboard ↗ on how to do that).
id String Unique image ID.
error String Error message if status != 200.

Code Samples

# Refer to the PixLab Github Repository at: https://github.com/symisc/pixlab for the full list of production ready code samples...
← Return to API Endpoint Listing