Interface ProjectParams

interface ProjectParams {
    disableNSFWFilter?: boolean;
    guidance: number;
    modelId: string;
    negativePrompt: string;
    numberOfImages: number;
    numberOfPreviews?: number;
    positivePrompt: string;
    scheduler?: Scheduler;
    seed?: number;
    startingImage?: File | Buffer | Blob;
    startingImageStrength?: number;
    steps: number;
    stylePrompt: string;
    timeStepSpacing?: TimeStepSpacing;
}

Properties

disableNSFWFilter? guidance modelId negativePrompt numberOfImages numberOfPreviews? positivePrompt scheduler? seed? startingImage? startingImageStrength? steps stylePrompt timeStepSpacing?

Properties

OptionaldisableNSFWFilter

disableNSFWFilter?: boolean

Disable NSFW filter for Project. Default is false, meaning NSFW filter is enabled. If image triggers NSFW filter, it will not be available for download.

guidance

guidance: number

Guidance scale. For most Stable Diffusion models, optimal value is 7.5

modelId

modelId: string

ID of the model to use, available models are available in the availableModels property of the ProjectsApi instance.

negativePrompt

negativePrompt: string

Prompt for what to be avoided

numberOfImages

numberOfImages: number

Number of images to generate

OptionalnumberOfPreviews

numberOfPreviews?: number

Number of previews to generate. Note that previews affect project cost\

positivePrompt

positivePrompt: string

Prompt for what to be created

Optionalscheduler

scheduler?: Scheduler

Scheduler to use

Optionalseed

seed?: number

Seed for one of images in project. Other will get random seed. Must be Uint32

OptionalstartingImage

startingImage?: File | Buffer | Blob

Generate images based on starting image. File - file object from input[type=file] Buffer - buffer object with image data Blob - blob object with image data

OptionalstartingImageStrength

startingImageStrength?: number

How strong effect of starting image should be. From 0 to 1, default 0.5

steps

steps: number

Number of steps. For most Stable Diffusion models, optimal value is 20

stylePrompt

stylePrompt: string

Image style prompt

OptionaltimeStepSpacing

timeStepSpacing?: TimeStepSpacing

Time step spacing method

Settings

Member Visibility

On This Page

Properties