Targeted Element API

The Targeted Element service allows you to transform a specific element in an image while preserving the rest of the composition.

Modify an element

POST /api/one_element/generate

This endpoint initiates a new generation to modify a specific element in your image. This operation also creates a new project.

Request Parameters

user_id
string
required

The unique user identifier (UUID) that you can retrieve from your Developer Space

image_url
string
required

URL of the image containing the element to modify (format: jpg, png)

element
string
required

Type of element to modify. Possible values: “WALL”, “FLOOR”, “CEILING”, “FURNITURE”, etc.

webhook
string

The URL we call once the generation is complete

Response

generation_id
string

The unique generation identifier (UUID) to use with the retrieval API

remaining_photos
number

The number of photos remaining after this generation

project_id
string

The unique project identifier (UUID)

Request Example

curl --request POST \
--url 'https://iacrea.com/api/one_element/generate' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "image_url": "https://example.com/image.jpg",
  "element": "WALL"
}'

Response Example

{
  "generation_id": "uuid",
  "remaining_photos": 100,
  "project_id": "uuid"
}

Generate a variation of a modification

POST /api/one_element/generate-variation

This endpoint allows you to generate a variation of a previously performed element modification.

Request Parameters

user_id
string
required

The unique user identifier (UUID)

generation_id
string
required

The unique identifier of the previous generation

room_type
string
required

Type of element to modify for this variation. Possible values: “WALL”, “FLOOR”, “CEILING”, “FURNITURE”, etc.

Response

generation_id
string

The unique identifier of the new generation

Request Example

curl --request POST \
--url 'https://iacrea.com/api/one_element/generate-variation' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid",
  "room_type": "FLOOR"
}'

Response Example

{
  "generation_id": "uuid"
}

Retrieve a generated modification

POST /api/one_element/get

This endpoint allows you to obtain the result of a previously performed generation.

Request Parameters

user_id
string
required

The unique user identifier (UUID)

generation_id
string
required

The unique identifier of the generation to retrieve

Response

status
string

The generation status: “STARTING”, “PROCESSING”, “SUCCEEDED”, “FAILED”

urls
array

An array containing the URLs of generated images (present only if status=“SUCCEEDED”)

variationNumber
number

The number of variations already performed on this project

Request Example

curl --request POST \
--url 'https://iacrea.com/api/one_element/get' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "user_id": "uuid",
  "generation_id": "uuid"
}'

Response Example

{
  "status": "SUCCEEDED",
  "urls": ["https://generated-image-url"],
  "variationNumber": 2
}

Important note: In case of “FAILED” status, your photos are automatically refunded.