Surface Normal

POST https://sdk.beeble.ai/v1/acquire/normal

Acquire surface normal from an image.
It typically delivers the best performance when used with portrait images.

Request

Authentication

Requests are authenticated with an API key. You need x-api-key header of your request.
Example: x-api-key: YOUR_API_KEY

Body

source_image

string($binary)
The source image to acquire normal.

Please upload the file as a part of the form data. Supported formats include .jpg, .png, and .webp. Images up to 2048x2048 resolution are accepted; images with higher resolution will be downscaled accordingly.

auto_key

bool
Indicates whether AI automatically remove the background.

If true, the AI automatically remove the background. If false, the alpha channel in the source_image is used to remove the background. However, if the source_image does not have an alpha channel, the AI still automatically remove the background. Default: true

preview

bool
Indicates whether a low-resolution preview output should be provided.

If true, an output of 512x512 resolution or lower will be deliverd at a higher speed, and 0.5 credit will be charged. If false, an output with a high-resolution up to 2048x2048 will be delieverd, and 1 credit will be charged. Default: false

Response

Body

200

Returns surface normal. (image/png)

Example Usage

For those who are not familiar with using API, we recommend using Postman (opens in a new tab).

curl --request POST \
  --url https://sdk.beeble.ai/v1/acquire/normal \
  --header 'x-api-key: YOUR_API_KEY' \
  --form source_image=@original.jpg \
  --form auto_key=true \
  --form preview=false \
  -o result.png # Remove if the image is broken; error will show.

Examples of input and output

source_image

result

Support

Any question? Contact us at info@beeble.ai or join our Discord channel (opens in a new tab).

All-in-One Albedo