index.markdown

API Documentation

Album

• Create an album
• Duplicate an album
• Duplicate an album with einstein_boxes
• Duplicate an album with tags
• Einstein null
• Listing albums
• No einstein boxes
• Rename an album
• Retrieve an album
• Retrieve stats
• Retrieve stats
• Trigger uploaded on an album
• destination album does not exist
• destination album exists. expecting failure
• destination album exists. expecting failure
• do not create an album
• moving images from source album to destination album
• rename takes place

Annotation

• Retrieve svg annotation on an image
• Upload annotations

Box Import

• Import einstein boxes
• Import einstein boxes

Clipboard

• Create a clipboard
• Create a clipboard
• Create a existing clipboard
• Paste clipboard

Cloudinary

• Post an image
• access is denied
• access is denied
• access is denied
• do not create images when there is an error but accept the payload

Downloads

• Add images to existing download
• Create a download with image_download
• Download belongs to another user
• Download on search
• No download ability

Einstein Prediction

• Create Einstein Prediction
• Create Einstein Prediction
• Create Einstein Prediction failed
• Create Einstein Prediction with large image format

EinsteinBox

• Create a new box
• Create a new box and tag already exists
• Delete a box
• Retrieve all einstein boxes on an image
• Retrieve all einstein boxes on an image and model
• Update an existing box

Image

• Pass image url
• Response has header Access-Control-Allow-Origin
• Retrieve 3 images tiled
• Retrieve an image
• Retrieve an image
• Retrieve image secured
• Retrieve image secured with private overlay
• Retrieve image secured without fl_attachment
• Retrieve image with angle parameter
• Retrieve image with angle parameter
• Return the image transformed
• Take image_id in token
• image_id not found

Image API

• Create an image
• Crop an image
• Delete an image
• Duplicate an image
• Listing images
• Listing images
• Listing images of an album
• Move multiple images across multiple albums
• Retrieve an image
• Retrieve an image embed code
• Retrieve username
• Retrieve username
• Retrieve username
• Retrieve username
• Rotate an image
• Search an image as plain query
• Search image with encoded parameters in authentication token
• Set image caption
• image_delete ability inside search token
• image_delete ability not in search token
• image_delete ability set to false inside search token
• image_delete is true for another album
• it deletes images and returns 200
• it does not delete images and returns 401
• match the image by a part of the filename

Image External Url

• Retrieve Cloudinary URL
• Retrieve external URL

Image Public External Url

• Redirect to image_external_url
• redirect to deleted placeholder

Image Sync

• album resync return images from ids with position
• retrieve all images sync payload
• retrieve all images sync payload with username

Image Url

• Retrieve an url for the image

Import

• Import a new image
• Import a new image
• Import a new image
• Import a new image
• Import from attachment
• Import from content document
• follow the redirection
• get import (not yet processed)
• get import (processed)
• import using storage

Native Upload

• Get upload form
• Get upload form (obsolete)
• Post an image
• Post batch information for expired token
• Post batch information for images with title and desc
• Post batch information for invalid token
• Post batch information for multiple image with tags
• Post batch information for multiple image with tags and auto_tag
• Post batch information for single image
• Post batch information for single image with tag
• Post batch information with no url
• Post image with annotations
• Post image with datetime in exifs
• Post image with datetime in metadata
• Post image with lat and long in exifs
• Post image with lat and long in metadata

Organization

• Retrieve the organization

Provider

• Retrieve the list of Providers

Provider reply

• Create provider reply

Provider request

• Create provider requests

Public Tag

• Retrieve public image from tag

Publication

• Create a publication
• Create a publication with text
• Create a publication with text from salesforce1
• Retrieve the album contained
• Retrieve the album contained

Secret

• Create a secret

Sticker API

• Listing all images in an sticker album
• Listing all images in an sticker album
• No image annotate ability

Storage file

• Create a new storage_file
• Create a new storage_file
• Create a new storage_file
• Create a new storage_file
• Return the storage_file with a image
• Return the storage_file with a image

Tag

• Create public tag
• Create public tag
• Create the tag
• Retreive visible tags
• Retrieve tags
• Returns autocomplete tags
• Returns autocomplete tags for einstein tags
• update public tag with download allowed

Tag Image

• Create tag images from tag id
• Create tag images from tag name
• Delete a tag image
• Retrieve tag images
• Retrieve tag images from image ids
• Retrieve tag images on a single image
• create the tag_images
• return subset of tag images

Tags Token

• Retreive tags by names
• Retreive tags by names
• Retreive tags by names
• Retreive tags by names
• Retreive tags by names

Thumbnails

• Signature is not valid
• Signature is valid
• Signature is valid
• Signature is valid
• image not found

TokenGenerator

• generate token from abilities

Trashed images

• Restore deleted images
• Restore deleted images
• Retrieve all deleted images
• Retrieve deleted images in album
• Return unauthorized error
• Return unauthorized error
• Return unauthorized error
• Return unauthorized error

User

• Retrieve current user

Zips

• generate the json representation of a zip
• return 400
• return 400
• return 400