v1

latestOpenAPI 3.1.02026-07-13161952.2 KB

Images

Modify 1 image

Partially update certain fields of an existing image by its ID.

patch/imgs/{image_id}

Query parameters

waitboolean

Wait for completion?

urgentboolean

Enqueue at head of queue if True

strictboolean

Use strict mode if True

langstring

en|es|pt|fr|ru

Request body

srcstring nullable

Url of the image in high or medium resolution (used as source for the AI).

url_img_watermarkstring nullable

URL of the watermarked image.

url_img_thumbnailstring nullable

URL of the thumbnail image.

titlestring nullable

A shorthand reference for the image.

headlinestring nullable

Short text describing the image.

captionstring nullable

Long text describing the image.

alt_textstring nullable

Text describing the visual appearance of an image (Accessibility).

ai_generatedboolean nullable

Image generated by Artificial Intelligence.

model_releaseboolean nullable

image with model release.

property_releaseboolean nullable

image with property release.

nsfwboolean nullable

Image Not Safe For Work.

statusstring nullable

Current status of the image.

datestring nullable

Date of the image creation in year-month-day format. Capture date for photographies.

locationstring nullable

A detailed description of the location, complementing the specified country and city with additional details such as street address or notable landmarks.

citystring nullable

Name of the country.

countrystring nullable

Name of the country.

eventstring nullable

Related event

authorstring nullable

The name of the individual or entity responsible for creating the image, such as a photographer or painter.

providerstring nullable

The identifier of the provider, which can be either a unique numeric ID or a descriptive name.

shotstring nullable

Type of photography shot.

scenestring nullable

Spot, place, visual location

techniquestring nullable

The specific method or process used in creating the artwork, reflecting the artist's unique approach or the traditional methods tied to certain mediums.

mediumstring nullable

The material or substance used in the creation of the artwork or object. This field corresponds to various artistic mediums like oils, acrylics, or digital formats.

keywordsstring[] nullable

Specific tags describing the image

categoriesstring[] nullable

General categories of the image

collectionsstring[] nullable

Collections that the image belongs to

Example request

{
  "src": "https://cdn.example.com/image/source.jpg",
  "url_img_watermark": "https://cdn.example.com/image/wm.jpg",
  "url_img_thumbnail": "https://cdn.example.com/image/thumb.jpg",
  "title": "image123",
  "headline": "Sunset over the Hudson River",
  "caption": "A vibrant orange sunset reflecting on the river with the city skyline in silhouette.",
  "status": "Active",
  "date": "2024-10-19",
  "location": "123 Main St, near Central Park",
  "city": "New York",
  "country": "United States",
  "event": "Oscar awards 2024",
  "author": "Jane Doe",
  "provider": "Acme Inc.",
  "shot": "Portrait",
  "scene": "Town square",
  "technique": "Drawing",
  "medium": "Oil on canvas",
  "keywords": [
    "Tree",
    "Dog",
    "Ball",
    "Water"
  ],
  "categories": [
    "Sport",
    "Fashion",
    "Politics"
  ],
  "collections": [
    "Steet pics",
    "Exclusive"
  ]
}

Response

image successfully modified

method'add' | 'upd' | 'del' | 'multiple' required

Tipo de respuesta asociada a una operación con imágenes.

resource'video' | 'image' | 'celebs' required

num_totalinteger required

Total of elements.

num_goodinteger required

Number of correctly processed elements.

num_badinteger required

Number of failed processed elements.

is_startedboolean required

Boolean indicating if the operation has started.

is_finishedboolean required

Boolean indicating if the operations has finished.

all_goodboolean nullable required

Boolean indicating that there is no failed elements yet.

do_waitboolean required

Boolean for know if have to wait or not.

do_urgentboolean required

Boolean for know if it is an urgent operation.

do_strictboolean required

Boolean for know if is required strict operations over DB.

idle_msnumber required

Duration (milliseconds) between the operation has been created and has started.

exec_msnumber required

Duration (milliseconds) between the operation has been started and has finished.

created_atstring required

Creation datetime.

started_atstring required

Start datetime.

finished_atstring required

Finalization datetime.