Images
Given a prompt and the model will generate a new image.
Input
import Heurist from 'heurist'
const heurist = new Heurist({
apiKey: process.env['HEURIST_API_KEY'], // This is the default and can be omitted
})
async function main() {
const response = await heurist.images.generate({
model: 'BrainDance',
})
}
main()
Response
{
"url": "https://heurist-images.s3.us-east-1.amazonaws.com/**********.png",
"model": "BrainDance",
"prompt": "xxxxxx"
}
Parameters
- Type:
ImageGenerateParams
Property | Type | Required | Description |
---|---|---|---|
model | ImageModel | true | The name of the model used, which specifies the particular model used to perform the generation or iteration. |
prompt | string | The main cue information used to generate the image or iteration. | |
neg_prompt | string | Negative cue messages used to specify that generation of content should be avoided. | |
num_iterations | number | Number of iterations to perform. (1-50) | |
guidance_scale | number | Guidance scale for adjusting the influence of certain parameters in the generation process. (1-20) | |
width | number | The width of the image. | |
height | number | The height of the image. | |
seed | number | Seed value to ensure repeatability of the generated results. |
Returns
- Type:
ImageGenerateParams & { url: string }
Property | Type | Required | Description |
---|---|---|---|
url | string | true | The URL link to the generated image. |
{
url: 'https://heurist-images.s3.us-east-1.amazonaws.com/**********.png',
model: 'BrainDance',
prompt: 'xxxxxx',
neg_prompt: 'xxxxxx',
...
}
Types
ImageModel
Supported model list can be found at https://docs.heurist.ai/integration/supported-models (opens in a new tab). Recommended models:
- BrainDance
- BlazingDrive
- YamersCartoonArcadia
- ArthemyComics
- ArthemyReal
- Aurora
- SDXLUnstableDiffusersV11
- AnimagineXL
- CyberRealisticXL
- DreamShaperXL
- AAMXLAnimeMix