AI Services

Generate an image using AI

Changed on Oct 20, 2023

This endpoint is used to generate an image using AI. It accepts a JSON object containing the image generation parameters and returns the generated image. The ImageCon V2 model is our Fastest and basic model for generating images that can handle image sizes of 1024x1024 and 1344x1024.

post/api/ai/images/generate/v3

Request

Base URL
https://api.worqhat.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/images/generate/v3/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

promptstring[]

The prompt and descriptions to be used for generating the image.

image_stylestring

The style of the image to be generated. You can choose between Abstract, Landscape, Portrait, Still Life, Animal, Anime, Architecture, etc.

output_type'url' | 'blob'

The type of output to be generated. You can choose between url and blob . URL will return a cloud-hosted Temporary URL for the generated image, you need to handle the image download on your end. blob will return the image as a base64 encoded string.

orientation'square' | 'portrait' | 'landscape'

The orientation of the image to be generated. You can choose between square , portrait, and landscape. square will generate a square image of dimensions 1024x1024. portrait will generate a portrait image of dimensions 1024x1344. landscape will generate a landscape image of dimensions 1344x1024.

Response

Image generated successfully

statusstring

Status indicating the success of the image generation.

imagestring

The generated image.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

Example response

{
  "status": "success",
  "image": "https://storage.googleapis.com/1fe0a9ac-617a-42e4-a376-37808b98fc99-worqhat/image-gen/MFl2oNxrMLYKvWbwoDkbQPpScWD3-1697226444718.png?GoogleAccessId=cloud-storage-upload%40worqhat-dev.iam.gserviceaccount.com&Expires=1697226626&Signature=DHlOeWd4QladLc6hsdoqp9lTbvMXs06B6hOkQPviFubszuLfahXXRv9aj%2FPTTlytlTClXHX0zGFr3Tsq9S%2Fs3hFjqBsy7lho%2BfuRFhPG4FrQoV2lxrZmB47X6nWc7TG6hbgLkyT3CvAOfwccmWHH1cbBiEDSI0iEKvx7kwUsgIrYu1ko9Szkul29fjVQ89WL6jyQQX1G9ejsQTNmXHFNRvhwRHkRfZJ5n3Y1uR7aqAyMZfQ2Me6i7bVb7smc0t5Ed2yk6%2BN1fdrz6zhbkc%2Fuh13vWhrT8EWMuCYKhsrzPakO%2B%2B229nlt5Y4D9zyFqevAmj43Vl76INIq29gcs39oQg%3D%3D",
  "processing_time": 2311,
  "processing_id": "cd185dd4-fcfb-4b15-93de-db9eded23ade",
  "processing_count": 1
}

Changes

Oct 20, 2023871850b7231f Revision changes
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  api operation id imageConV3 removed and replaced with generateImageV3
- info
  the endpoint scheme security bearerAuth was added to the API
- info
  api tag AI Services added
- info
  api tag AI removed
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Aug 15, 2023b5ffe2a9748f Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  api operation id imageConV3 was added
- info
  api tag AI added
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (5 revisions)