fal-ai/patina/material

Generate complete seamlessly tiling PBR materials including normal, roughness, basecolor, height and metalness maps up to 8K

Inference

Commercial use

Schema

LLMs

Playground API

About

Generate a complete PBR material from a text prompt.

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/patina/material", {
  input: {
    prompt: "mossy stone wall"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/patina/material", {
  input: {
    prompt: "mossy stone wall"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/patina/material", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/patina/material", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

The text prompt describing the material/texture to generate.

image_size ImageSize | Enum

Output texture dimensions in pixels. Default value: square_hd

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}

num_inference_steps integer

Number of denoising steps for texture generation. Default value: 8

seed integer

Random seed for reproducible generation.

num_images integer

Number of texture images to generate. Default value: 1

enable_prompt_expansion boolean

Expand prompt with an LLM for richer detail. Adds ~0.0025 credits. Default value: true

enable_safety_checker boolean

Enable the safety checker for generated images. Default value: true

tiling_mode TilingModeEnum

Tiling direction: 'both' (omnidirectional), 'horizontal', or 'vertical'. Default value: "both"

Possible enum values: both, horizontal, vertical

tile_size integer

Tile size in latent space (64 = 512px, 128 = 1024px). Default value: 128

tile_stride integer

Tile stride in latent space. Default value: 64

image_url string

URL of an input image for image-to-image or inpainting. When provided without mask_url, performs image-to-image; with mask_url, performs inpainting.

mask_url string

URL of a mask image for inpainting. White regions are regenerated, black regions are preserved. Requires image_url.

strength float

How much to transform the input image. Only used when image_url is provided. Default value: 0.75

maps list<Enum>

Which PBR maps to predict. Deselect all to skip PBR estimation entirely. Defaults to all five.

upscale_factor UpscaleFactorEnum

Upscale factor for predicted PBR maps via SeedVR seamless upscaling. 0 = no upscaling, 2 = 2× resolution, 4 = 4× resolution. The base texture image is not upscaled. Default value: "0"

Possible enum values: 0, 2, 4

output_format OutputFormatEnum

Output image format for textures and PBR maps. Default value: "png"

Possible enum values: jpeg, png, webp

{
  "prompt": "mossy stone wall",
  "image_size": "square_hd",
  "num_inference_steps": 8,
  "num_images": 1,
  "enable_prompt_expansion": true,
  "enable_safety_checker": true,
  "tiling_mode": "both",
  "tile_size": 128,
  "tile_stride": 64,
  "strength": 0.75,
  "maps": [
    "basecolor",
    "normal",
    "roughness",
    "metalness",
    "height"
  ],
  "output_format": "png"
}

Output#

images list<ImageFile | MapImageFile>* required

Generated tileable texture image(s) from z-image and predicted PBR material maps from PATINA.

seed integer* required

Seed used for texture generation.

prompt string* required

The prompt used for texture generation (possibly expanded).

timings Timings

End-to-end timing breakdown (seconds).

{
  "images": [
    {
      "url": "https://v3b.fal.media/files/b/0a95760d/dX7FhHPQ0TOIESx9CyFdw_lhjHZKSq.png"
    },
    {
      "map_type": "basecolor",
      "url": "https://v3b.fal.media/files/b/0a957610/LdI7qAvd7sOGArS_nD1L4_sL2PbKYz.png"
    },
    {
      "map_type": "height",
      "url": "https://v3b.fal.media/files/b/0a957610/AVQruI2Vtm7y-lRBVbr34_Xc9WmnMW.png"
    },
    {
      "map_type": "normal",
      "url": "https://v3b.fal.media/files/b/0a957610/V4Xj_KI9I-a6b-UEfIgrO_gQY8TeTS.png"
    },
    {
      "map_type": "roughness",
      "url": "https://v3b.fal.media/files/b/0a957610/Eij1cULDUCTFHrglS9hT0_LWz3ZVhI.png"
    },
    {
      "map_type": "metalness",
      "url": "https://v3b.fal.media/files/b/0a957610/tDGew4uKe1yxZYOPVoDEV_fmcwUVeE.png"
    }
  ],
  "prompt": ""
}

Other types#

MapImageFile#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the image

height integer

The height of the image

map_type MapTypeEnum* required

Which PBR map this image represents.

Possible enum values: basecolor, normal, roughness, metalness, height

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

ImageFile#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

width integer

The width of the image

height integer

The height of the image

fal-ai/patina/material

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

MapImageFile#

ImageSize#

ImageFile#

Related Models