API Explorer

API Credentials

API Access TokenGet an access token

• Asset Methods

  • List Methods
  • Expand Methods

  • GETGet Asset/assets/:identifier
    This method allows you to retrieve a specific asset
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Asset Comments/chutes/:chute_id/assets/:asset_id/comments
    This method retrieves the comments on an asset (requires a specific Chute)
    
    

    Parameter	Value	Type	Description
    chute_id		string	ID (integer) or shortcut (string) for the Chute
    asset_id		string	ID (integer) or shortcut (string) for the Asset

  • DELETERemove Asset/assets/:identifier
    This method allows you to remove a specific asset
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • POSTRemove Assets/assets/remove
    This method allows you to remove a group of assets
    
    

    Parameter	Value	Type	Description
    asset_ids		json	Array of Asset IDs

  • POSTSet Thumbnail/assets/:identifier/init
    This method allows you to set the default (75x75) thumbnail for a specific asset
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)
    thumbnail		string	Base 64 encoded image thumbnail

• Bundle Methods

  • List Methods
  • Expand Methods

  • POSTCreate a Bundle/bundles/
    This method allows you to create a bundle
    
    

    Parameter	Value	Type	Description
    asset_ids		json	Array of Asset IDs

  • GETGet Bundle/bundles/:identifier
    This method allows you to retrieve a specific bundle
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Bundle Assets/bundles/:identifier/assets
    This method retrieves the assets contained within a bundle
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • DELETERemove Bundle/bundles/:identifier
    This method allows you to remove a specific bundle
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • POSTRemove Assets from a Bundle/bundles/:identifier/remove
    This method allows you to remove a group of assets
    
    

    Parameter	Value	Type	Description
    identifier		json	ID (integer) or shortcut (string)
    asset_ids		json	Array of Asset IDs

• Chute Methods

  • List Methods
  • Expand Methods

  • POSTCreate Chute/chutes
    This method allows you to create a chute
    
    

    Parameter	Value	Type	Description
    chute[name]		string	See Chute Form JSON for details

  • GETGet Chutes/me/chutes
    This method allows get a list of chutes in the account
    
    
  • GETGet Chute/chutes/:identifier
    This method allows you to retrieve a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Chute Assets/chutes/:identifier/assets
    This method retrieves the assets associated with a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Chute Contributors/chutes/:identifier/contributors
    This method retrieves a list of members who have contributed assets to the chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Chute Members/chutes/:identifier/members
    This method retrieves a list of members for a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETGet Chute Parcels/chutes/:identifier/parcels
    This method retrieves a timeline of parcels added to a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • PUTUpdate Chute/chutes/:identifier
    This method allows you to udpate the properties of a chute
    
    

    Parameter	Value	Type	Description
    identifier		json	ID (integer) or shortcut (string)
    chute[name]		json	Name of the chute

  • DELETERemove Chute/chutes/:identifier
    This method allows you to remove a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • POSTAdd Assets to a Chute/chutes/:identifier/assets/add
    This method allows you to add assets to a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)
    asset_ids		json	Array of Asset IDs

  • POSTRemove Assets from a Chute/chutes/:identifier/assets/remove
    This method allows you to remove assets from a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)
    asset_ids		json	Array of Asset IDs

• Membership Methods

  • List Methods
  • Expand Methods

  • POSTInvite to a Chute/chutes/:identifier/invite
    This method allows you to add a member to a specific chute
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)
    providers		json	See Chute Membership Form JSON for details

• Parcel Methods

  • List Methods
  • Expand Methods

  • POSTCreate a Parcel/parcels/
    This method allows you to create a new parcel
    
    

    Parameter	Value	Type	Description
    files		json	File data for new files to verify/upload. See File JSON for details
    assets		json	Array of existing asset ids
    chutes		json	Array of existing chute ids to deliver the parcel to

  • GETGet Parcel/parcels/:id
    This method allows you to retrieve a specific parcel
    
    

    Parameter	Value	Type	Description
    id		integer	ID of the parcel

  • POSTMark Parcel as complete/parcels/:id/complete
    This method instructs Chute that all files for the parcel have been uploaded
    
    

    Parameter	Value	Type	Description
    id		integer	ID of the parcel

• Search Methods

  • List Methods
  • Expand Methods

  • GETKey Search/meta/:type/:key
    This method allows you to search for all objects with a matching key set
    
    

    Parameter	Value	Type	Description
    type	all**assetschutesparcelsusers	enumerated	Type of object to search for
    key		string	Key name to search for

• Social Methods

  • List Methods
  • Expand Methods

  • GETHeart an Asset/assets/:identifier/heart
    This method allows you to heart a specific asset
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • GETUnheart an Asset/assets/:identifier/unheart
    This method removes a heart from a specific asset
    
    

    Parameter	Value	Type	Description
    identifier		string	ID (integer) or shortcut (string)

  • POSTComment on an Asset/chutes/:chute_id/assets/:asset_id/comments
    This method adds a comment to an asset in a specific chute
    
    

    Parameter	Value	Type	Description
    chute_id		string	ID (integer) or shortcut (string) for the Chute
    asset_id		string	ID (integer) or shortcut (string) for the Asset

  • DELETERemove Comment/comments/:id
    This method removes a comment from an asset in a specific chute
    
    

    Parameter	Value	Type	Description
    id		integer	ID of the Comment

• Upload Methods

  • List Methods
  • Expand Methods

  • POSTRegister Uploads/assets/verify
    This method checks to see if an asset has already been uploaded or not. Should be called at the start of any upload.
    
    

    Parameter	Value	Type	Description
    files		json	File data for new files to verify/upload. See Files JSON for details

  • GETUpload Token/uploads/:asset_id/token
    This method generates an upload token for a specific asset. Must be called to retrieve the upload URL.
    
    

    Parameter	Value	Type	Description
    asset_id		integer	ID of the Asset

  • POSTComplete Upload/uploads/:asset_id/complete
    This method is used to indicate that an asset has successfully uploaded and begins processing.
    
    

    Parameter	Value	Type	Description
    asset_id		integer	ID of the Asset