Authorizations
Your Freepik API key. Required for authentication. Learn how to obtain an API key
Body
The prompt is a short text that describes the image you want to generate or edit. It can range from simple descriptions, like "a cat"
, to detailed scenarios, such as "a cat with wings, playing the guitar, and wearing a hat"
. This field is required for both image generation and editing.
"A beautiful sunset over mountains with vibrant orange and purple skies"
Optional array of reference images for image editing. Each image can be provided as a Base64 encoded string or a publicly accessible URL. Maximum of 3 reference images allowed. If provided, the model will use these images as reference for editing or style transfer.
3
Reference image as Base64 encoded string or publicly accessible URL
[
"iVBORw0KGgoAAAANSUhEUgAAASwAAAEsAQAAAABRBrPYAAABrElEQVR4nO3BMQEAAADCoPVPbQ0Po...",
"https://example.com/reference-image.jpg"
]
Optional callback URL that will receive asynchronous notifications whenever the task changes status. The payload sent to this URL is the same as the corresponding GET endpoint response, but without the data field.
"https://www.example.com/webhook"
Response
OK - The task exists and the status is returned
{
"generated": [
"https://openapi-generator.tech",
"https://openapi-generator.tech"
],
"task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"status": "CREATED"
}