ImageBlock

The ImageBlock type represents an image. It includes the image’s metadata and any extracted information.

Schema

FieldTypeDescription
idstringUnique identifier
createdAtdatetimeCreation timestamp
updatedAtdatetimeLast update timestamp
sourceIdstringID of the data source
remoteIdstringID in original system
urlstringImage URL
pathstring[]File path
pathStringstringPath as string
mimeTypestringMIME type
originalNamestringOriginal filename
sizenumberFile size in bytes
widthnumberImage width
heightnumberImage height
captionstringImage caption
altstringAlt text
propertiesobjectAdditional properties
tagsstring[]Image tags

Example Usage

// Get all images
const { data } = await unbody.get
  .imageBlock
  .select("url", "width", "height")
  .exec();
 
// Search images
const { data } = await unbody.get
  .imageBlock
  .search.about("my search query")
  .exec();
 
// Filter images
const { data } = await unbody.get
  .imageBlock
  .where({ mimeType: "image/jpeg" })
  .exec();

Next Steps

©2024 Unbody