Images

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
PropertyTypeRequiredDescription
modelImageModeltrueThe name of the model used, which specifies the particular model used to perform the generation or iteration.
promptstringThe main cue information used to generate the image or iteration.
neg_promptstringNegative cue messages used to specify that generation of content should be avoided.
num_iterationsnumberNumber of iterations to perform. (1-50)
guidance_scalenumberGuidance scale for adjusting the influence of certain parameters in the generation process. (1-20)
widthnumberThe width of the image.
heightnumberThe height of the image.
seednumberSeed value to ensure repeatability of the generated results.

Returns

  • Type: ImageGenerateParams & { url: string }
PropertyTypeRequiredDescription
urlstringtrueThe 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