Documentation » API » Objects » Photo

Represents a photo, either in an album or as an image attached to a post, a comment, or a message.

id
string

The (server-wide) unique identifier of this photo.

ap_id
string

Globally-unique ActivityPub identifier for this photo. Use this to match photos across servers.

url
string

The URL of the web page representing this photo. For photos uploaded by remote users, points to their home server.

album_id
string

If this photo is in an album, the identifier of that album.

owner_id
integer

The identifier of the owner of this photo.

user_id
integer

For a photo in an album in a group, the identifier of the user who uploaded this photo to the album.

text
string

A textual description of the photo. In case of post attachments, often used as an “alt text” to describe the image for the visually-impaired.

date
integer

The unixtime timestamp when this photo was uploaded.

blurhash
string

The BlurHash for the thumbnail.

sizes
array of objects

An array describing the differently-sized images available for this photo.

url
string

The URL of this image size. The format of the image is determined by the image_format global parameter.

width
integer (positive)

The width of this size in pixels.

height
integer (positive)

The height of this size in pixels.

type
enum

The designator for this size.

  • s – Scaled to fit into a 100x100 square
  • m – Scaled to fit into a 320x320 square
  • x – Scaled to fit into a 640x640 square
  • y – Scaled to fit into a 800x800 square
  • z – Scaled to fit into a 1280x1280 square
  • w – Scaled to fit into a 2560x2560 square
width
integer (positive)

The width of the largest-size image for this photo in pixels.

height
integer (positive)

The height of the largest-size image for this photo in pixels.

Extended fields

Returned by some photos.* methods that take the extended parameter, when that parameter is set to true.

likes
object

Information about likes of this post.

count
integer (non-negative)

How many users liked this photo.

can_like
boolean

Whether the current user can like this photo.

user_likes
boolean

Whether the current user likes this photo.

comments
integer (non-negative)

The total number of comments on this photo.

can_comment
boolean

Whether the current user can comment on this photo.

tags
integer (non-negative)

The total number of people tagged in this photo.