Skip to main content
Version: 1.11.0-beta

React SDK Hooks Reference

The React SDK provides the following hooks, all of which require being inside an ImagineoAIProvider:

Image Hooks

  • useGenerateImage
  • useUploadImage
  • useUpscale
  • useInpaint
  • useOutpaint
  • useDescribe

Prompt Hooks

  • useGetPrompt
  • useListPrompts
  • useEnhancePrompt
  • useUpdatePrompt
  • useDeletePrompt

Example: Generate Image

import { useGenerateImage } from '@imagineoai/react';

const { generateImage } = useGenerateImage();
const [result, setResult] = useState(null);

async function handle() {
const res = await generateImage({ ... });
setResult(res);
}

See the JavaScript SDK reference for input/output types and advanced usage.