You are viewing the legacy documentation for the Google Photos Library API.
Photos Library API
Stay organized with collections
Save and categorize content based on your preferences.
Manage photos, videos, and albums in Google Photos
Service: photoslibrary.googleapis.com
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://photoslibrary.googleapis.com
| Methods |
addEnrichment |
POST /v1/albums/{albumId}:addEnrichment
Adds an enrichment at a specified position in a defined album. |
batchAddMediaItems |
POST /v1/albums/{albumId}:batchAddMediaItems
Adds one or more media items in a user's Google Photos library to an album. |
batchRemoveMediaItems |
POST /v1/albums/{albumId}:batchRemoveMediaItems
Removes one or more media items from a specified album. |
create |
POST /v1/albums
Creates an album in a user's Google Photos library. |
get |
GET /v1/albums/{albumId}
Returns the album based on the specified albumId. |
list |
GET /v1/albums
Lists all albums shown to a user in the Albums tab of the Google Photos app. |
patch |
PATCH /v1/albums/{album.id}
Update the album with the specified id. |
share |
POST /v1/albums/{albumId}:share
Marks an album as shared and accessible to other users. |
unshare |
POST /v1/albums/{albumId}:unshare
Marks a previously shared album as private. |
| Methods |
get |
GET /v1/sharedAlbums/{shareToken}
Returns the album based on the specified shareToken. |
join |
POST /v1/sharedAlbums:join
Joins a shared album on behalf of the Google Photos user. |
leave |
POST /v1/sharedAlbums:leave
Leaves a previously-joined shared album on behalf of the Google Photos user. |
list |
GET /v1/sharedAlbums
Lists all shared albums available in the Sharing tab of the user's Google Photos app. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThe Google Photos Library API allows developers to manage photos, videos, and albums programmatically using REST resources.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create, update, and delete albums; add and remove media items; and share albums with others using specific endpoints.\u003c/p\u003e\n"],["\u003cp\u003eMedia items can be created, retrieved, updated, searched, and listed using the API, enabling comprehensive media management functionalities.\u003c/p\u003e\n"],["\u003cp\u003eShared albums can be retrieved, joined, and left using designated endpoints, providing functionalities for collaborative photo sharing experiences.\u003c/p\u003e\n"],["\u003cp\u003eAll API requests are relative to the base service endpoint: \u003ccode\u003ehttps://photoslibrary.googleapis.com\u003c/code\u003e.\u003c/p\u003e\n"]]],["This content details how to interact with Google Photos via its API, accessible at `https://photoslibrary.googleapis.com`. Actions include managing albums (creating, listing, getting, updating, adding/removing media, sharing, unsharing), and media items (creating, listing, getting, updating, searching). It also covers managing shared albums (getting, joining, leaving, listing). Each action corresponds to specific HTTP methods (POST, GET, PATCH) at defined endpoints.\n"],null,["# Photos Library API\n\nManage photos, videos, and albums in Google Photos\n\n- [REST Resource: v1.albums](#v1.albums)\n- [REST Resource: v1.mediaItems](#v1.mediaItems)\n- [REST Resource: v1.sharedAlbums](#v1.sharedAlbums)\n\nService: photoslibrary.googleapis.com\n-------------------------------------\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://photoslibrary.googleapis.com`\n\nREST Resource: [v1.albums](/photos/library/legacy/reference/rest/v1/albums)\n---------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| [addEnrichment](/photos/library/legacy/reference/rest/v1/albums/addEnrichment) | `POST /v1/albums/{albumId}:addEnrichment` Adds an enrichment at a specified position in a defined album. |\n| [batchAddMediaItems](/photos/library/legacy/reference/rest/v1/albums/batchAddMediaItems) | `POST /v1/albums/{albumId}:batchAddMediaItems` Adds one or more media items in a user's Google Photos library to an album. |\n| [batchRemoveMediaItems](/photos/library/legacy/reference/rest/v1/albums/batchRemoveMediaItems) | `POST /v1/albums/{albumId}:batchRemoveMediaItems` Removes one or more media items from a specified album. |\n| [create](/photos/library/legacy/reference/rest/v1/albums/create) | `POST /v1/albums` Creates an album in a user's Google Photos library. |\n| [get](/photos/library/legacy/reference/rest/v1/albums/get) | `GET /v1/albums/{albumId}` Returns the album based on the specified `albumId`. |\n| [list](/photos/library/legacy/reference/rest/v1/albums/list) | `GET /v1/albums` Lists all albums shown to a user in the Albums tab of the Google Photos app. |\n| [patch](/photos/library/legacy/reference/rest/v1/albums/patch) | `PATCH /v1/albums/{album.id}` Update the album with the specified `id`. |\n| [share](/photos/library/legacy/reference/rest/v1/albums/share) | `POST /v1/albums/{albumId}:share` Marks an album as shared and accessible to other users. |\n| [unshare](/photos/library/legacy/reference/rest/v1/albums/unshare) | `POST /v1/albums/{albumId}:unshare` Marks a previously shared album as private. |\n\nREST Resource: [v1.mediaItems](/photos/library/legacy/reference/rest/v1/mediaItems)\n-----------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|\n| [batchCreate](/photos/library/legacy/reference/rest/v1/mediaItems/batchCreate) | `POST /v1/mediaItems:batchCreate` Creates one or more media items in a user's Google Photos library. |\n| [batchGet](/photos/library/legacy/reference/rest/v1/mediaItems/batchGet) | `GET /v1/mediaItems:batchGet` Returns the list of media items for the specified media item identifiers. |\n| [get](/photos/library/legacy/reference/rest/v1/mediaItems/get) | `GET /v1/mediaItems/{mediaItemId}` Returns the media item for the specified media item identifier. |\n| [list](/photos/library/legacy/reference/rest/v1/mediaItems/list) | `GET /v1/mediaItems` List all media items from a user's Google Photos library. |\n| [patch](/photos/library/legacy/reference/rest/v1/mediaItems/patch) | `PATCH /v1/mediaItems/{mediaItem.id}` Update the media item with the specified `id`. |\n| [search](/photos/library/legacy/reference/rest/v1/mediaItems/search) | `POST /v1/mediaItems:search` Searches for media items in a user's Google Photos library. |\n\nREST Resource: [v1.sharedAlbums](/photos/library/legacy/reference/rest/v1/sharedAlbums)\n---------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| [get](/photos/library/legacy/reference/rest/v1/sharedAlbums/get) | `GET /v1/sharedAlbums/{shareToken}` Returns the album based on the specified `shareToken`. |\n| [join](/photos/library/legacy/reference/rest/v1/sharedAlbums/join) | `POST /v1/sharedAlbums:join` Joins a shared album on behalf of the Google Photos user. |\n| [leave](/photos/library/legacy/reference/rest/v1/sharedAlbums/leave) | `POST /v1/sharedAlbums:leave` Leaves a previously-joined shared album on behalf of the Google Photos user. |\n| [list](/photos/library/legacy/reference/rest/v1/sharedAlbums/list) | `GET /v1/sharedAlbums` Lists all shared albums available in the Sharing tab of the user's Google Photos app. |"]]
