WomboDream | wombo-dream-api

Hierarchy

WomboDream

Constructors

constructor

new WomboDream(authentifier: GoogleAuthentifier, apiTaskUrl: string, apiUserSuffix: string, apiTaskSuffix: string, apiShopSuffix: string, apiStyleSuffix: string, apiGallerySuffix: string, originUrl: string, uploadUrl: string): WomboDream

- Defined in src/WomboDream.ts:16
Parameters
- authentifier: GoogleAuthentifier
- apiTaskUrl: string
- apiUserSuffix: string
- apiTaskSuffix: string
- apiShopSuffix: string
- apiStyleSuffix: string
- apiGallerySuffix: string
- originUrl: string
- uploadUrl: string
Returns WomboDream

Properties

apiGallerySuffix

apiGallerySuffix: string

apiShopSuffix

apiShopSuffix: string

apiStyleSuffix

apiStyleSuffix: string

apiTaskSuffix

apiTaskSuffix: string

apiTaskUrl

apiTaskUrl: string

apiUserSuffix

apiUserSuffix: string

authentifier

authentifier: GoogleAuthentifier

originUrl

originUrl: string

uploadUrl

uploadUrl: string

Methods

buildApiGalleryUrl

buildApiGalleryUrl(taskId: string): string

- Defined in src/WomboDream.ts:54
Parameters
- taskId: string
Returns string

buildApiStyleUrl

buildApiStyleUrl(): string

- Defined in src/WomboDream.ts:42
Returns string

buildApiTaskShopUrl

buildApiTaskShopUrl(taskId: string): string

- Defined in src/WomboDream.ts:48
Parameters
- taskId: string
Returns string

buildApiTaskUrl

buildApiTaskUrl(taskId: string): string

- Defined in src/WomboDream.ts:28
Parameters
- taskId: string
Returns string

buildHttpRequestAgent

buildHttpRequestAgent(config: AxiosRequestConfig<any>): Promise<AxiosInstance>

Create a new HTTP request agent with custom headers

example

const agent = await dreamInstance.buildHttpRequestAgentForApiUser({baseURL: "https://app.wombo.art", headers: {Authorization: "Bearer 12345"}});
agent.get('https://app.wombo.art').then(res => console.log(res.data));

Parameters

config: AxiosRequestConfig<any>

Returns Promise<AxiosInstance>

buildHttpRequestAgentForDreamApi

buildHttpRequestAgentForDreamApi(): Promise<AxiosInstance>

Create a new HTTP request agent with custom headers for dream API

example

const agent = await dreamInstance.buildHttpRequestAgentForDreamApi();
agent.get('https://app.wombo.art').then(res => console.log(res.data));

Returns Promise<AxiosInstance>

buildHttpRequestAgentForUserAPI

buildHttpRequestAgentForUserAPI(): Promise<AxiosInstance>

Create a new HTTP request agent with custom headers for user API

example

const agent = await dreamInstance.buildHttpRequestAgentForApiUser();
agent.post('https://app.wombo.art/api/users', {username: "myusername"}).then(res => console.log(res.data));

Returns Promise<AxiosInstance>

buildRawApiGalleryUrl

buildRawApiGalleryUrl(): string

- Defined in src/WomboDream.ts:60
Returns string

buildRawApiTaskUrl

buildRawApiTaskUrl(): string

- Defined in src/WomboDream.ts:34
Returns string

buildUploadUrl

buildUploadUrl(): string

- Defined in src/WomboDream.ts:38
Returns string

configureTask

configureTask(task: Task, prompt: string, style: number, input_image?: TaskImageInputSpec, display_freq?: number): Promise<Task>

- Defined in src/WomboDream.ts:162
Configure an existing Task
warning
must be done with the same account as the task was created

example
```
const task:Task;
dreamInstance.configureTask(task, "kitten", 34).then(console.log);
```
Parameters
- task: Task
- prompt: string
- style: number
- Optional input_image: TaskImageInputSpec
  
  use an image as input
- display_freq: number = DEFAULT_DISPLAY_FREQ
  
  how often the task makes intermediate renders
Returns Promise<Task>

createTask

createTask(prompt: string, style: number, input_image?: TaskImageInputSpec, display_freq?: number): Promise<Task>

- Defined in src/WomboDream.ts:207
Create and configure an existing Task
example
```
dreamInstance.createTask("kitten", 34).then(console.log);
```
Parameters
- prompt: string
- style: number
- Optional input_image: TaskImageInputSpec
  
  use an image as input
- display_freq: number = DEFAULT_DISPLAY_FREQ
  
  how often the task makes intermediate renders
Returns Promise<Task>

deleteGalleryTask

deleteGalleryTask(taskGalleryId: number): Promise<void>

- Defined in src/WomboDream.ts:465
Fetch a gallery saved task
warning
task_id != task_gallery_id

warning
you must be logged as a user to use it

example
```
const taskGalleryId:number;
dreamInstance.deleteGalleryTask(taskGalleryId);
```
Parameters
- taskGalleryId: number
Returns Promise<void>

fetchGalleryTask

fetchGalleryTask(taskGalleryId: number): Promise<SavedTask>

- Defined in src/WomboDream.ts:421
Fetch a gallery saved task
warning
task_id != task_gallery_id

warning
you must be logged as a user to use it

example
```
const taskGalleryId:number;
dreamInstance.fetchGalleryTask(taskGalleryId).then(console.log);
```
Parameters
- taskGalleryId: number
Returns Promise<SavedTask>

fetchGalleryTasks

fetchGalleryTasks(): Promise<SavedTask[]>

- Defined in src/WomboDream.ts:443
Fetch gallery saved tasks
warning
you must be logged as a user to use it

example
```
dreamInstance.fetchGalleryTasks().then(console.log);
```
Returns Promise<SavedTask[]>

fetchStyles

fetchStyles(): Promise<<internal>.Style[]>

- Defined in src/WomboDream.ts:343
Fetch all available styles
example
```
dreamInstance.fetchStyles().then(console.log);
```
Returns Promise<<internal>.Style[]>

fetchTaskInfos

fetchTaskInfos(taskId: string): Promise<Task>

- Defined in src/WomboDream.ts:244
Fetch the current infos of a Task
warning
must be done with the same account as the task was created

example
```
const taskId:string;
dreamInstance.fetchTaskInfos(taskId).then(console.log);
```
Parameters
- taskId: string
Returns Promise<Task>

fetchTaskShopUrl

fetchTaskShopUrl(taskId: string): Promise<String>

- Defined in src/WomboDream.ts:364
Fetch shop url from task id
warning
must be done with the same account as the task was created

example
```
const taskId:string;
dreamInstance.fetchTaskShopUrl(taskId).then(console.log);
```
Parameters
- taskId: string
Returns Promise<String>

generatePicture

generatePicture(prompt: string, style: number, progressCallback?: (task: Task) => void, input_image?: TaskImageInputSpec, checkFrequency?: number, display_freq?: number): Promise<Task>

- Defined in src/WomboDream.ts:270
Create a new task and generate a picture
example
```
dreamInstance.generatePicture('kitten', 34, (task) => {
            console.log(task.state, 'stage', task.photo_url_list.length);
        })
        .then((task) => console.log(task?.result.final))
        .catch(console.error);
```
Parameters
- prompt: string
- style: number
- progressCallback: (task: Task) => void = ...
  
  a callback function that will be called with the progress of the Task
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
- Optional input_image: TaskImageInputSpec
  
  use an image as input
- checkFrequency: number = DEFAULT_CHECK_FREQ
- display_freq: number = DEFAULT_DISPLAY_FREQ
  
  how often the task makes intermediate renders
Returns Promise<Task>

initTask

initTask(): Promise<Task>

- Defined in src/WomboDream.ts:132
Initialize new Task

The Task wont start until it is configured
example
```
dreamInstance.initTask().then(console.log);
```
Returns Promise<Task>

saveTaskToGallery

saveTaskToGallery(taskId: string, name?: string, isPublic?: boolean, isPromptVisible?: boolean): Promise<SavedTask>

- Defined in src/WomboDream.ts:388
Save task to the gallery
warning
must be done with the same account as the task was created

warning
you must be logged as a user to use it

example
```
const taskId:string;
dreamInstance.saveTaskToGallery(taskId, "wonderful kitty").then(console.log);
```
Parameters
- taskId: string
- name: string = ''
- isPublic: boolean = false
- isPromptVisible: boolean = true
Returns Promise<SavedTask>

setUsername

setUsername(username: string): Promise<void>

- Defined in src/WomboDream.ts:487
Set account username
warning
YOU NEED TO SET A USERNAME TO INTERRACT WITH GALLERY

example
```
dreamInstance.setUsername("myusername");
```
Parameters
- username: string
Returns Promise<void>

uploadImage

uploadImage(bufferedImage: <internal>.Buffer): Promise<UploadResource>

- Defined in src/WomboDream.ts:307
Upload an image for later use
warning
jpg/jpeg are the only supported image formats

example
```
dreamInstance.uploadImage(fs.readFileSync('./image.jpg')).then(console.log);
```
Parameters
- bufferedImage: <internal>.Buffer
Returns Promise<UploadResource>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

authentifier: GoogleAuthentifier

apiTaskUrl: string

apiUserSuffix: string

apiTaskSuffix: string

apiShopSuffix: string

apiStyleSuffix: string

apiGallerySuffix: string

originUrl: string

uploadUrl: string

Returns WomboDream

Properties

apiGallerySuffix

apiShopSuffix

apiStyleSuffix

apiTaskSuffix

apiTaskUrl

apiUserSuffix

authentifier

originUrl

uploadUrl

Methods

buildApiGalleryUrl

Parameters

taskId: string

Returns string

buildApiStyleUrl

Returns string

buildApiTaskShopUrl

Parameters

taskId: string

Returns string

buildApiTaskUrl

Parameters

taskId: string

Returns string

buildHttpRequestAgent

Parameters

config: AxiosRequestConfig<any>

Returns Promise<AxiosInstance>

buildHttpRequestAgentForDreamApi

Returns Promise<AxiosInstance>

buildHttpRequestAgentForUserAPI

Returns Promise<AxiosInstance>

buildRawApiGalleryUrl

Returns string

buildRawApiTaskUrl

Returns string

buildUploadUrl

Returns string

configureTask

Parameters

task: Task

prompt: string

style: number

Optional input_image: TaskImageInputSpec

display_freq: number = DEFAULT_DISPLAY_FREQ

Returns Promise<Task>

createTask

Parameters

prompt: string

style: number

Optional input_image: TaskImageInputSpec

display_freq: number = DEFAULT_DISPLAY_FREQ

Returns Promise<Task>

deleteGalleryTask

Parameters

taskGalleryId: number

Returns Promise<void>

fetchGalleryTask

Parameters

taskGalleryId: number

Returns Promise<SavedTask>