Imageshack API
Get user images from tag
General Information
The Imageshack API is a RESTful API which uses HTTP requests and JSON responses.
This API is still in development; however, it is mostly completed and going forward all modifications will be backwards compatible. Please report any issues to is-support@imageshack.us
API Key
All non GET requests to the api require a Imageshack api key. You may request one from here:
https://imageshack.com/contact/api
Send the api key as a param to all requests
“api_key=<key>”
Authentication
Provide a username or email and password. The api will respond with an auth_token. Pass the auth_token as a param to each API to access private data.
Imageshack Login
Route | https://api.imageshack.com/v2/user/login |
Method | POST |
Response |
Params
Key | Required | Value |
user | string | The username or email of the user logging in |
password | string | The corresponding password to the user |
auth_token | string | user and password may be substituted by auth_token |
set_cookies | boolean | When TRUE auth cookies will be set in the user's browser. Allowing the user to use imageshack |
remember_me | boolean | When TRUE and used with set_cookies the cookies will expire in 365 days instead of after session close. |
Pagination
Many of the API endpoints support pagination. By default the responses will be limited at 20. Imageshack uses the limit and offset system. To increase number of records set the limit param. Use the offset param to pull different pages. For example:
Page 1
limit=20 offset=0
Page 2
limit=20 offset=20
page 3
limit=20 offset=40
Error Handling
When an error occurs an error Model will be displayed and the success flag will be false.
Json Example
{ |
Error codes
- SystemError(1, "System Error"),
- MissingRequiredParameter(2, "Missing required parameter"),
- InvalidParameterValue(3, "Invalid parameter value"),
- ServiceFailure(4, "Failed to process the request"),
- PrivilegeError(5, "Not enough privileges "),
- DataAccessError(6, "Failed to access datastore"),
- InvalidApiKeyOrAuthToken(8, "Invalid ApiKey or authToken"),
- MissingAuthToken(9, "Missing Auth Token"),
- MissingApiKey(10, "Missing Api Key"),
- InvalidEmailOrPassword(14, "Invalid email or password"),
- ImageshackAuthenticationFailure(18, "Failed to authenticate imageshack user account"),
- InvalidUserId(20, "Invalid User Id"),
- InvalidPassword(28, "Invalid Password"),
- EmailNotUnique(29, "EmailId not unique"),
- UsernameNotUnique(30, "Username not unique"),
- AlbumTitleAlreadyExists(31, "Album title already exists")
Response Models
User Model
Contains user properties and settings
key | Format | Description |
is_owner | boolean | States if auth_token and username match |
cache_version | integer | Current user version. Every account activity increments this number |
user_id | integer | Internal persistent unique identifier for the user. Only shown when user is owner. |
string | User’s email address. Only shown when user is owner. | |
username | string | The username of the user |
description | string | The user’s bio |
creation_date | integer | The creation date/time as a unix timestamp |
location | string | The user’s location |
first_name | string | The user’s first name |
last_name | string | The user’s last name |
Avatar->id | string | Unique alphanumeric image id of the user’s avatar image |
Avatar->server | integer | The server location of the user’s avatar image |
Avatar->filename | string | The filename of the user’s Avatar |
membership | string | The user’s membership. “Pro”, “premium”, or “free” |
is_following | boolean | True if user is being followed by the caller. requires authentication. |
following_allowed | boolean | True if use allows following |
latest_images | array of images | the last 5 images uploaded by the user |
Json example
{ "success":true, "process_time":137, "result":{ "is_owner":false, "cache_version":32, "userid":null, "email":null, "username":"photohackday", "description":"Hello, my name is Nick", "creation_date":1365146199, "location":"Los Gatos, CA", "gender":"male", "first_name":"Nick", "last_name":"Dude", "avatar":{ "id":"5slogolightcropp", "server":208, "filename":"logolightcrop.png" }, "membership":"free", "is_following":false, "following_allowed":true, "latest_images":[ { "id":"11img0317hJ", "server":37, "filename":"img0317h.JPG" }, { "id":"0himg0319gqj", "server":17, "filename":"img0319gq.jpg" }, { "id":"04img0320dmj", "server":4, "filename":"img0320dm.jpg" }, { "id":"5slogolightcropp", "server":208, "filename":"logolightcrop.png" }, { "id":"jaimg0318lj", "server":694, "filename":"img0318l.jpg" } ] } } |
User Usage Model
Key | Format | Description |
images_count | integer | The total number of images in the account |
album_images_count | integer | The total number of images in albums in account |
root_images_count | integer | The number of images not part of an album |
space_limit | integer | User storage limit in kilobytes (5 gigs for free accounts) |
space_used | integer | Total space used in kilobytes |
Json Example
{ |
Login Model
Contains authentication information.
Key | Format | Description |
auth_token | string | The authorization token |
user_id | integer | Internal persistent unique identifier for the user |
string | Email address of the user | |
username | string | The username |
Avatar->id | integer | Unique alphanumeric image id of the user’s avatar image. |
Avatar->server | integer | The server location of the user’s avatar |
Avatar->filename | string | The filename of the user’s Avatar |
membership | string | The membership status. |
membership_item_number | string | The membership item number. For pro accounts. |
membership_cookie | string | The membership cookie. For pro accounts. |
Json Example
{ "email":"fakeemail@imageshack.us", "membership":"free", |
User Settings Model
Key | Format | Description |
private_profile | boolean | If true the user’s public pages will not be available for viewing |
private_images | boolean | If true user images will be set to non-public by default during upload |
private_albums | boolean | If true user albums will be set to non-public by default during upload |
private_files | boolean | If true user files will be set to non-public by default during upload |
private_followings | boolean | If true user will not be able to be followed |
upload_notification | boolean | If true user will receive a notification for each upload |
comments_notification | boolean | If true user will receive a notification for comments on their images |
shares_notification | boolean | If true user will receive a notification when someone shares their image |
likes_notification | boolean | If true user will receive a notification when someone likes one of their images |
follows_notification | boolean | If true user will receive a notification when someone follows them |
new_feature_notification | boolean | If true user will receive a notification for new site features |
weekly_update_notification | boolean | If true user will receive a weekly email report with all their uploads |
daily_update_notification | boolean | If true user will receive a daily email report with all their uploads |
skypath_message | boolean | If true user will receive a notification for skypath messages |
skypath_share_file | boolean | If true user will receive a notification for skypath shared images |
onboarding | boolean | true if the user has been through onboarding |
Json Example:
{ "private_followings":false, "skypath_message":false, "skypath_share_file":false, "onboarding":false } |
Image Model
Contains properties and web locations of the image.
Key | Format | Description |
id | string | Unique alphanumeric image id |
server | integer | Server location |
bucket | integer | bucket directory |
filename | string | The filename on the server |
original_filename | string | The original filename sent from user |
direct_link | string | Direct link to the file |
title | string | User set title of the image |
description | string | Image description |
tags | string array | Array of user generated tags |
liked | boolean | True if current authenticated user liked image |
likes | integer | Number of likes the image has received |
views | integer | Number of landing page views the image has received |
moderated | boolean | true if the image has been moderated |
album->id | string | Unique alphanumeric album id. Only displays if image is in an album |
album->title | string | Album tile. Only displays if image is in an album |
album->public | boolean | States whether the album is marked public. Only displays if image is in an album |
comments_count | integer | Number of comments associated with image |
comments_disabled | boolean | Specifies whether or not the image allows comments |
filter | integer | User specified image filter 0-23. 0 is no filter |
filesize | integer | file size in kilobytes |
creation_date | integer | The creation date/time as a unix timestamp |
width | integer | The width of the image |
height | integer | the height of the image |
public | boolean | States whether the image is marked public |
is_owner | boolean | States if auth_token owns this image |
owner->username | string | The username of the owner. Only displayed on images marked as public |
owner->avatar->id | string | Unique alphanumeric image id. Only shown on images marked as public |
owner->avatar->server | integer | Server location of the owner’s avatar. Only shown on images marked as public |
owner->avatar->filename | string | Filename of the owner’s avatar. Only shown on images marked as public |
next_images[] | array | Array of next images. default 2 |
previous_images[] | array | Array of previous images. default 2 |
related_images[] | array | An array of related images |
Json Example:
{ "moderated":true, "album_id":"B02F", "album_title":"Tahoe Snow", |
Basic Image Model
A minimal image model. Used for array of images.
Key | Format | Description |
id | string | Unique alphanumeric image id |
server | integer | Server location |
bucket | integer | bucket directory |
filename | string | The filename on the server |
original_filename | string | The original filename sent from user |
title | string | User generated image title |
album_id | string | Unique alphanumeric album id. Only displays if image is in an album |
album_title | string | Album tile. Only displays if image is in an album |
creation_date | integer | The creation date/time as a unix timestamp |
public | boolean | States whether the image is marked public |
hidden | boolean | States whether the image has been deleted |
filesize | integer | file size in kilobytes |
width | integer | The width of the image |
height | integer | the height of the image |
owner->username | string | The username of the owner. Only displayed on images marked as public |
owner->avatar->id | string | unique alphanumeric image id |
owner->avatar->server | integer | Server location of the owner’s avatar. Only shown on images marked as public |
owner->avatar->filename | string | Filename of the owner’s avatar. Only shown on images marked as public |
Json example
{ |
Images List Model
Contains a list of basic image objects from user accounts
Key | Format | Description |
base_url | string | Base of the direct links. Append server/bucket/filename to build the link |
limit | integer | Number of images returned (pagination) |
offset | integer | Number of images to offset (pagination) |
total | integer | Total number of images in account |
images | array | An array of Basic Image Models |
Json example
{ |
Upload Model
The model returned on upload or transload
Key | Format | Description |
max_filesize | integer | The maximum filesize the current user is allowed in kilobytes |
space_limit | integer | The maximum account storage limit in kilobytes |
space_used | integer | The current storage used in kilobytes |
space_left | integer | The difference from space_limit and space_used in kilobytes |
passed | integer | The number of images uploaded successfully |
failed | integer | The number of images upload failures. |
images | array | An array of the Basic Image Models successfully uploaded |
Album Model
Contains properties and contents of the album.
Key | Format | Description |
id | string | Unique alphanumeric album id |
title | string | User set album title |
description | string | User generated album description. 200 char limit. |
creation_date | integer | The creation date/time as a unix timestamp |
public | boolean | States whether the album is marked public |
is_owner | boolean | States if auth_token owns this album |
owner->username | string | Username of the owner of the album. Only shows if the album is marked public. |
owner->avatar->id | string | Unique alphanumeric id of user’s avatar image |
owner->avatar->server | integer | Server location of the owner’s avatar. Only shown on images marked as public |
owner->avatar->filename | string | Filename of the owner’s avatar. Only shown on images marked as public |
limit | integer | Number of images returned (pagination) |
offset | integer | Number of images to offset (pagination) |
total | integer | Total number of images in album |
images[] | array of images | An array of Basic Image Models |
Json Example:
{ |
Basic Album Model
A minimal version of the album Model.
Key | Format | Description |
id | string | Unique alphanumeric album id |
title | string | User set album title |
creation_date | integer | The creation date/time as a unix timestamp |
public | boolean | States whether the album is marked public |
total | integer | Total number of images in album |
is_owner | boolean | States if auth_token owns this album |
owner->username | string | Username of the owner of the album. Only shows if the album is marked public. |
owner->avatar->id | string | Unique alphanumeric id of user’s avatar image |
owner->avatar->server | integer | Server location of the owner’s avatar. Only shown on images marked as public |
owner->avatar->filename | string | Filename of the owner’s avatar. Only shown on images marked as public |
images[] | array of images | An array of Basic Image Models |
Json Example
{ |
Albums List Model
Contains a list of albums from a user account
Key | Format | Description |
limit | integer | Number of albums returned (pagination) |
offset | integer | Number of albums to offset (pagination) |
total | integer | Total number of albums in account |
albums | array | An array of Basic Album Models |
Json Example
{ |
Tag Model
Contains an array of images associated with the tag
Key | Format | Description |
total | integer | Number of images total associated with the tag |
images | array | An array of Basic Image Models |
Json Example:
{ |
Tags List Model
Contains a list of albums from a user account
Key | Format | Description |
limit | integer | Number of albums returned (pagination) |
offset | integer | Number of albums to offset (pagination) |
total | integer | Total number of albums in account |
tags | array | An array of Tag Model |
Json Example:
{ |
Image Comment Model
Key | Format | Description |
id | string | Message unique id as a string |
comment | string | Text portion of the comment |
source | string | Source of the create call. Web, Mobile, App name, etc |
owner->username | string | Username of the owner of the comment |
owner->avatar->id | string | Unique alphanumeric id of user’s avatar image |
owner->avatar->server | integer | Server location of the owner’s avatar |
owner->avatar->filename | string | Filename of the owner’s avatar |
Json Example
{ "id":"2i0b90d6626e2f6aa9796cc4cj”, |
Image Comments List Model
Key | Format | Description |
limit | integer | Number of comments displayed |
end_offset | string | End offset. Used for pagination. |
start_offset | string | Start offset. Used for pagination. |
total | integer | Total number of comments |
comments | array | An array of Comment Models |
Json Example
{ |
Bulk Model
Key | Format | Description |
passed | integer | Number of successful requests |
failed | integer | Number of failed requests |
total | integer | Total number of requests |
{title} | array | Array of result models depending on the usage |
Followers Images Model
Contains a list of images from followers/followings
Key | Format | Description |
limit | integer | Limit the number of images to display |
start_offset | string | End offset. Used for pagination. |
end_offset | string | Start offset. Used for pagination. |
images | array | An array of Basic Image Models |
Json Example
{ |
Endpoints
User API
Get User
Gets user information
Route | https://api.imageshack.com/v2/user/<username> |
Method | GET |
Response |
Params
Key | Required | Value |
image_limit | n | limits the number of latest images to display. defaults 5 |
Create User
Create a new user
Route | https://api.imageshack.com/v2/user |
Method | POST |
Response |
Params
Key | Required | Value |
y | Specify an email for the new user | |
username | n | Specify a username for the new user. If none specified a username will be created from the email address. |
password | n | Specify a password for the new user. If none is specified a random password will be generated. The password will be sent to the email address. |
first_name | n | User's first name. Requires last_name |
last_name | n | User's last name. Requires first_name |
gender | n | User's gender |
location | n | User's location |
description | n | User bio |
set_cookies | n | When TRUE auth cookies will be set in the user's browser after successful sign up |
remember_me | n | When TRUE and used with set_cookies the cookies will expire in 365 days instead of after session close. |
Update User
Update user account. You must be logged in.
Route | https://api.imageshack.com/v2/user/<username> |
Method | PUT/PATCH |
Response |
Params
Key | Required | Value |
username | n | Specify a new username for the user |
n | Specify a new email for the user | |
password | n | Specify a new password for the user |
first_name | n | User's first name. Requires last_name |
last_name | n | User's last name. Requires first_name |
gender | n | User's gender |
location | n | User's location |
description | n | User bio |
avatar_sever | n | Avatar's server location. Requires avatar_filename |
avatar_filename | n | Avatar's filename. Requires avatar_server |
Delete User
Delete user account. Require authentication.
Route | https://api.imageshack.com/v2/user/<username> |
Method | DELETE |
Response | TRUE/FALSE |
Get User Usage
Gets user usage and media counts
Route | https://api.imageshack.com/v2/user/<username>/usage |
Method | GET |
Response |
Params
key | Required | Value |
hide_empty | n | Exclude empty albums from album count |
show_private | n | Includes private images in counts |
show_hidden | n | Includes hidden(deleted) images in counts |
Get User Settings
Gets user settings such as privacy and notifications settings. Requires Authentication.
Route | https://api.imageshack.com/v2/user/settings |
Method | GET |
Response |
Update User Settings
Gets user settings such as privacy and notifications settings. Requires Authentication.
Route | https://api.imageshack.com/v2/user/settings |
Method | PUT or PATCH |
Response |
Params
key | Required | Value |
private_profile | n | Sets profile to be private. Public pages will not be viewable |
private_images | n | Sets images to be non-public by default on upload |
private_albums | n | Sets albums to be non-public by default on upload |
private_files | n | Sets files to be non-public by default on upload |
private_followings | n | Toggles user following privacy setting |
upload_notification | n | Toggles notifications for all uploads |
comments_notification | n | Toggles notifications for comments |
shares_notification | n | Toggles notifications for shared images |
likes_notification | n | Toggles notifications for liked images |
follows_notification | n | Toggles notifications for following events |
new_feature_notification | n | Toggles notifications for new features |
weekly_update_notification | n | Toggles notifications for weekly uploads report |
daily_update_notification | n | Toggles notifications for daily uploads report |
skypath_message | n | Toggles notifications for Skypath messages |
skypath_share_file | n | Toggles notifications for Skypath shared images |
onboarding | n | Toggles onboarding flag |
Get User Images
Provides a list of the all the images associated with the user
Route | https://api.imageshack.com/v2/user/<username>/images |
Method | GET |
Response |
Params
key | Required | Value |
show_private | n | include private images. Requires authentication |
show_hidden | n | Includes hidden(deleted) images. Requires authentication. |
hide_folder_images | n | Hides images from albums |
show_only_private | n | Return only private images. Requires authentication |
Get Random User Images
Provides a random list of images associated with the user
Route | https://api.imageshack.com/v2/user/<username>/images/random |
Method | GET |
Response | array of Basic Image Models |
Get user albums
Provides a list of the all the albums associated with the user
Route | https://api.imageshack.com/v2/user/<username>/albums |
Method | GET |
Response |
Params
key | Required | Values |
image_limit | n | Number of images to return for each album |
show_private | n | Include private images. Requires authentication |
hide_empty | n | Hides empty albums |
show_only_private | n | Return only private albums. Requires authentication |
Get user tags
Provides a list of all the tags w/ images associated with the user. Requires authentication.
Route | https://api.imageshack.com/v2/user/<username>/tags |
Method | GET |
Response |
Params
Key | Required | Value |
limit | n | Number of images returned (pagination) |
offset | n | Number of images to offset (pagination) |
image_limit | n | Specifies the number of images to return for each tag |
Get user Images from tag
Retrieves images associated with tag. Requires authentication.
Route | https://api.imageshack.com/v2/user/<username>/tags/<tag> |
Method | GET |
Response | Array of Basic Image Models |
Params
Key | Required | Value |
limit | n | Number of images returned (pagination) |
offset | n | Number of images to offset (pagination) |
Forgot Password
Sends a forgot password reset email to user
Route | https://api.imageshack.com/v2/user/<user>/forgot |
Method | POST |
Response | TRUE/FALSE |
Password reset
Reset password with auth hash from forgot password API
Route | https://api.imageshack.com/v2/user/<user>/password_reset |
Method | POST |
Response | TRUE/FALSE |
Params
Key | Required | Value |
auth | y | The auth hash from Forgot Password API email response. |
password | y | A new password |
Image API
Upload image
Upload an image. Requires authentication.
Route | https://api.imageshack.com/v2/images |
Method | POST |
Response |
Params
Key | Required | Value |
file(s[])@ | y | Image binary(s). May send multiple images. Use ‘files[]’ array param when sending multiple images. |
album | n | Album title or album id to attach files to. If album exists files will be added. If not a new album will be created. |
title(s[]) | n | Set a title for the image. Use ‘titles[]’ array param or ‘titles’ param separated by commas for multiple image titles. |
description(s[]) | n | Set a description for the image. Use descriptions[]’ array param or descriptions param separated by commas for multiple image descriptions. |
tags | n | List of tags to attach to the image. Array or csv |
public | n | Sets public setting. Default is true. |
filter | n | User specified image filter 0-23. 0 is no filter. Will be applied images transloaded. |
comments_disabled | n | Disable comments for the specific image |
Transload image
transload an image. Requires authentication.
Route | https://api.imageshack.com/v2/images |
Method | POST |
Response | Upload Model |
Params
Key | Required | Value |
urls[] | y | Url(s) of image(s) to transload |
album | n | Album title or album id to attach files to. If album exists files will be added. If not a new album will be created. |
title(s[]) | n | Set a title for the image. Use ‘titles[]’ array param or ‘titles’ param separated by commas for multiple image titles. |
description(s[]) | n | Set a description for the image. Use descriptions[]’ array param or descriptions param separated by commas for multiple image descriptions. |
tags | n | List of tags to attach to the image. Array or csv |
public | n | Sets public setting. Default is true. Will be applied images transloaded. |
filter | n | User specified image filter 0-23. 0 is no filter. Will be applied images transloaded. |
comments_disabled | n | Disable comments for the specific image |
Get Image
Get an image
Route | https://api.imageshack.com/v2/images/<id> |
Method | GET |
Params
Key | Required | Values |
next_prev_limit | n | Sets the limit of next and previous images returned. Default is 2 |
related_images_limit | n | Sets the limit of related images to be returned. Default is 10 |
Get Multiple Images
Lookup multiple images
Route | https://api.imageshack.com/v2/images |
Method | GET |
Response |
Params
Key | Required | Values |
ids | y | Comma separated list of image IDs or ids[] array. Example: ids=eb96484058j,go4anjaj,bb3zdkiwbj or ids[]=eb96484058j ids[]=go4anjaj ids[]=bb3zdkiwbj |
next_prev_limit | n | Sets the limit of next and previous images returned. Default is 2 |
Update Image
Updates an image’s properties. Requires authentication.
Route | https://api.imageshack.com/v2/images/<id> |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
title | n | Set a title for the image |
description | n | Set a description for the image |
tags | n | List of tags to attach to the image. Array or csv |
original_filename | n | Rename the original_filename. |
public | n | Sets public setting. Default is true. |
filter | n | User specified image filter 0-23. 0 is no filter. |
comments_disabled | n | Disable comments for the specific image |
Update Multiple Images
Updates multiple images
Route | https://api.imageshack.com/v2/images |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
ids | y | Comma separated list of image IDs or ids[] array. Example: ids=eb96484058j,go4anjaj,bb3zdkiwbj or ids[]=eb96484058j ids[]=go4anjaj ids[]=bb3zdkiwbj |
title | n | Set a title for the image |
description | n | Set a description for the image |
tags | n | List of tags to attach to the image. Array or csv |
public | n | Sets public setting. Default is true. |
filter | n | User specified image filter 0-23. 0 is no filter. |
comments_disabled | n | Disable comments for the specific image |
Delete Image
Delete an image. Requires authentication.
Route | https://api.imageshack.com/v2/images/<id> |
Method | DELETE |
Response | TRUE/FALSE |
Delete bulk Images
Delete multiple images. Requires authentication.
Route | https://api.imageshack.com/v2/images |
Method | DELETE |
Params
Key | Required | Values |
ids | y | Comma separated list of image IDs or ids[] array. Example: ids=eb96484058j,go4anjaj,bb3zdkiwbj or ids[]=eb96484058j ids[]=go4anjaj ids[]=bb3zdkiwbj |
Get image likes
Gets a list of users who liked the image. Requires authentication of image owner.
Route | https://api.imageshack.com/v2/images/<id>/likes |
Method | GET |
Response | array of User Model |
Like image
Likes an image. Requires authentication.
Route | https://api.imageshack.com/v2/images/<id>/likes |
Method | POST/PUT |
Response | TRUE/FALSE |
Unlike image
Unlikes an image. Requires authentication.
Route | https://api.imageshack.com/v2/images/<id>/unlike |
Method | POST/PUT |
Response | TRUE/FALSE |
Get Related images
Returns a list of related images.
Route | https://api.imageshack.com/v2/images/<id>/related |
Method | GET |
Response | Array of server and file names |
Params
Key | Required | Values |
limit | n | Sets the limit of related images to be returned. Default is 10 |
Get Image tags
Get tags from image
Route | https://api.imageshack.com/v2/images/<id>/tags |
Method | GET |
Response | Array of Tags |
Tag Image
Tag an image with one or more tags. Requires authentication.
Route | https://api.imageshack.com/v2/images/<id>/tags |
Method | PUT |
Response | TRUE/FALSE |
Params
Key | Required | Values |
tags | y | List of tags to attach to image. Array or csv |
Tag Images
Tag multiple images with one or more tags. Requires authentication.
Route | https://api.imageshack.com/v2/images/tags |
Method | PUT |
Response |
Params
Key | Required | Values |
ids | y | List of image IDs. Array or csv. |
tags | y | List of tags to attach to image. Array or csv |
Delete Image Tags
Remove one or more tags from an image. Requires authentication.
Route | https://api.imageshack.com/v2/images/<image_id>/tags |
Method | DELETE |
Response |
Params
Key | Required | Values |
tags | n | List of tags to remove from image. If omitted all tags will be removed. |
Delete Images Tags
Remove one or more tags from multiple images. Requires authentication.
Route | https://api.imageshack.com/v2/images/tags |
Method | DELETE |
Response |
Params
Key | Required | Values |
ids | y | List of image IDs. Array or csv. |
tags | n | List of tags to remove from image. If omitted all tags will be removed. |
Album API
Create Album
Creates a new album. Require authentication.
Route | https://api.imageshack.com/v2/albums |
Method | POST |
Response |
Params
Key | Required | Values |
title | y | The title of the album |
description | n | Set a description for the album. 200 char limit. |
public | n | Set album privacy level. Default is TRUE. |
files[] | n | Array of image ids to add to the newly created album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj |
Get Album
Get an album
Route | https://api.imageshack.com/v2/albums/<id> |
Method | GET |
Response |
Get Multiple Albums
Lookup multiple albums
Route | https://api.imageshack.com/v2/albums |
Method | GET |
Response |
Params
Key | Required | Values |
ids | y | Comma separated list of album IDs or ids[] array Example: ids=TzcF,i5VF or ids[]=TzcF ids[]=i5VF |
Update Album
Update an album. Require authentication.
Route | https://api.imageshack.com/v2/albums/<id> |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
title | n | The title of the album |
description | n | Set a description for the image |
public | n | Set album privacy level. Default is TRUE. |
Update Multiple Albums
Updates multiple albums. Require authentication.
Route | https://api.imageshack.com/v2/albums |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
ids | y | Comma separated list of album IDs or ids[] array Example: ids=TzcF,i5VF or ids[]=TzcF ids[]=i5VF |
description | n | Set a description for the image |
public | n | Set album privacy level. Default is TRUE. |
Set album Images
Set or replace images in an album. Require authentication.
Route | https://api.imageshack.com/v2/albums/<id> |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
files[] | y | Array of image ids to replace images in existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj |
Add Images to Album
Add new images to an album. Require authentication.
Route | https://api.imageshack.com/v2/albums/<id>/add_files |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
files[] | y | Array of image ids to add to an existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj |
Delete Images from Album
Delete images from an album. Require authentication.
Route | https://api.imageshack.com/v2/albums/<id>/delete_files |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
files[] | y | Array of image ids to delete from an existing album. Ex: files[]=eb96484058j&files[]=bb3zdkiwbj&files[]=go4anjaj |
Delete Album
Delete an album. Require authentication.
Route | https://api.imageshack.com/v2/albums/<id> |
Method | DELETE |
Response | TRUE/FALSE |
Delete Multiple Albums
Deletes multiple albums. Require authentication.
Route | https://api.imageshack.com/v2/albums |
Method | PUT/PATCH |
Response |
Params
Key | Required | Values |
ids | y | Comma separated list of album IDs or ids[] array Example: ids=TzcF,i5VF or ids[]=TzcF ids[]=i5VF |