Social Library

Get Assets

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/assets

Search for assets.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Query Parameters
namerequiredtypedescription
queryfalsestring

Full-text search term. Searches text content of the post, author display name and author username.

folderfalsestring

Filter assets by folder ID. Find all assets in this folder.

folderTreefalsestring

Filter assets recursively by folder ID. Find all assets in this folder and any subfolders.

generatorfalsestring

Filter by the service that generated the content (e.g. twitter.com, instagram.com).

viafalseinteger

Filter by how the content was added to asset manager.

rightsfalseinteger

Filter by rights request status.

tagsfalsestring

Filter by tags.

limitfalseinteger

Number of Assets to return per batch. Default is 50.

sincefalsestring

Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting ascending.

untilfalsestring

Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting descending.

Responses

200

Successful search.

Example application/json
{
  "assets": [
    {
      "library": {
        "id": "example.fyre.co"
      },
      "createdAt": "2016-01-15T01:47:47.660Z",
      "updatedAt": "2016-01-15T01:47:47.660Z",
      "folders": [],
      "content": {
        "published": "2016-01-15T01:47:35.000Z",
        "content": "Asset Manager is great! <a target=\"_blank\" href=\"https://t.co/T3hYROVul2\" title=\"\" rel=\"nofollow\">t.co/T3hYROVul2</a>",
        "attributedTo": {
          "id": "435430712",
          "displayName": "Jonathan Klaassen",
          "username": "jaklaassen",
          "description": "",
          "location": "",
          "url": {
            "href": "https://twitter.com/jaklaassen"
          },
          "icon": {
            "displayName": "jaklaassen",
            "url": {
              "href": "https://pbs.twimg.com/profile_images/572868817777197056/AuKGdis0_normal.jpeg"
            }
          }
        },
        "attachment": [
          {
            "thumbnail_height": 150,
            "link": {
              "href": "http://twitter.com/jaklaassen/status/687813347992047623/photo/1"
            },
            "width": 300,
            "author_url": {
              "href": "http://twitter.com/jaklaassen"
            },
            "type": "photo",
            "url": {
              "href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:large"
            },
            "version": "1.0",
            "title": "Jonathan Klaassen on Twitter",
            "thumbnail_width": 150,
            "thumbnail_url": {
              "href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:thumb"
            },
            "height": 225,
            "author_name": "jaklaassen",
            "provider_url": {
              "href": "http://twitter.com"
            },
            "provider_name": "Twitter"
          }
        ],
        "lang": "en",
        "twitter": {
          "retweets": 0,
          "favorites": 0
        },
        "generator": {
          "id": "twitter.com"
        },
        "id": "687813347992047623"
      },
      "id": "twitter.com.687813347992047623.example.fyre.co"
    }
  ],
  "paging": {
    "hasPrev": true,
    "total": 842045,
    "totalItems": 842045
  }
}
400

There was a validation error.

403

Invalid authentication

Update Assets

posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/assets

Add or update assets.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Request Body

Content-Type: application/json

propertytypedescription
addarray

Assets to add to the Asset Library.

add.[]object
add.[].idstring

The foreign ID of the content (e.g. Instagram's ID for Instagram content).

add.[].generatorobject

The service or system where the content was originally published (e.g. twitter.com for tweets).

add.[].generator.idstring

The Livefyre generator ID. Commonly used generators are:

  • twitter.com
  • instagram.com
  • youtube.com
add.[].contentobject
add.[].content.idstring

The foreign ID of the content (e.g. Instagram's ID for Instagram content).

add.[].content.attachmentarray
add.[].content.attachment.[]object

An embeddable object, such as a video or photo.

add.[].content.attachment.[].versionstring

The oEmbed version number. This must be 1.0.

add.[].content.attachment.[].typestring

The Oembed type. Valid values are:

  • photo
  • video
  • link
  • rich
  • link
add.[].content.attachment.[].linkobject
add.[].content.attachment.[].link.hrefstring
add.[].content.attachment.[].urlobject

The URL of the content. For photos, this should be embeddable in an tag.

add.[].content.attachment.[].url.hrefstring
add.[].content.attachment.[].htmlstring

The HTML required to display the resource. This may be a video player for video or arbitrary content for rich.

add.[].content.attachment.[].thumbnail_urlobject
add.[].content.attachment.[].thumbnail_url.hrefstring
add.[].content.attachment.[].heightinteger
add.[].content.attachment.[].widthinteger
add.[].content.attachment.[].thumbnail_heightinteger
add.[].content.attachment.[].thumbnail_widthinteger
add.[].content.attachment.[].provider_namestring
add.[].content.attachment.[].provider_urlstring
add.[].content.attachment.[].author_namestring
add.[].content.attachment.[].author_urlobject
add.[].content.attachment.[].author_url.hrefstring
add.[].content.contentstring

The text content.

add.[].content.generatorobject

The service or system where the content was originally published (e.g. twitter.com for tweets).

add.[].content.generator.idstring

The Livefyre generator ID. Commonly used generators are:

  • twitter.com
  • instagram.com
  • youtube.com
add.[].content.attributedToobject
add.[].content.attributedTo.idstring
add.[].content.attributedTo.usernamestring
add.[].content.attributedTo.urlobject
add.[].content.attributedTo.url.hrefstring
add.[].content.attributedTo.displayNamestring
add.[].content.attributedTo.iconobject
add.[].content.attributedTo.icon.urlobject
add.[].content.attributedTo.icon.url.hrefstring
add.[].content.twitterobject

Twitter-specific content.

add.[].content.twitter.retweetsinteger

Count of retweets.

add.[].content.twitter.favoritesinteger

Count of favorites.

add.[].foldersarray

A list of Asset Folders to add the Asset to.

add.[].folders.[]string
removearray

IDs of Assets to remove from the Asset Library.

remove.[]string

Responses

200

Successful search.

400

There was a validation error.

403

Invalid authentication

Get Asset

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/asset/{asset}

Get an asset

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

assettruestring

The Asset ID.

Responses

200

Success

Example application/json
{
  "library": {
    "id": "example.fyre.co"
  },
  "createdAt": "2016-01-15T01:47:47.660Z",
  "updatedAt": "2016-01-15T01:47:47.660Z",
  "folders": [],
  "content": {
    "published": "2016-01-15T01:47:35.000Z",
    "content": "Asset Manager is great! <a target=\"_blank\" href=\"https://t.co/T3hYROVul2\" title=\"\" rel=\"nofollow\">t.co/T3hYROVul2</a>",
    "attributedTo": {
      "id": "435430712",
      "displayName": "Jonathan Klaassen",
      "username": "jaklaassen",
      "description": "",
      "location": "",
      "url": {
        "href": "https://twitter.com/jaklaassen"
      },
      "icon": {
        "displayName": "jaklaassen",
        "url": {
          "href": "https://pbs.twimg.com/profile_images/572868817777197056/AuKGdis0_normal.jpeg"
        }
      }
    },
    "attachment": [
      {
        "thumbnail_height": 150,
        "link": {
          "href": "http://twitter.com/jaklaassen/status/687813347992047623/photo/1"
        },
        "width": 300,
        "author_url": {
          "href": "http://twitter.com/jaklaassen"
        },
        "type": "photo",
        "url": {
          "href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:large"
        },
        "version": "1.0",
        "title": "Jonathan Klaassen on Twitter",
        "thumbnail_width": 150,
        "thumbnail_url": {
          "href": "https://pbs.twimg.com/media/CYuamFyWcAAOo92.jpg:thumb"
        },
        "height": 225,
        "author_name": "jaklaassen",
        "provider_url": {
          "href": "http://twitter.com"
        },
        "provider_name": "Twitter"
      }
    ],
    "lang": "en",
    "twitter": {
      "retweets": 0,
      "favorites": 0
    },
    "generator": {
      "id": "twitter.com"
    },
    "id": "687813347992047623"
  },
  "id": "twitter.com.687813347992047623.example.fyre.co"
}
400

There was a validation error.

403

Invalid authentication

List Asset Folders

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folders

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Query Parameters
namerequiredtypedescription
idfalsearray

Filter Asset by ID.

pathfalsearray

Filter Asset Folders by parent path(s). Defaults to '/', which returns top-level folders.

limitfalseinteger

Number of Assets to return per batch. Default is 50.

sincefalsestring

Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting ascending.

untilfalsestring

Used for paging. Pass this value into the since parameter in the request to get the next batch of values when sorting descending.

Responses

200

Success

Example application/json
{
  "folders": [
    {
      "id": "1",
      "children": [
        "2",
        "3"
      ],
      "label": "My Folder",
      "path": "/",
      "inherit": false
    }
  ]
}
400

There was a validation error.

403

Invalid authentication

Update Asset Folders

posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folders

Create, update or delete Asset Folders.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Request Body

Content-Type: application/json

Responses

200

Success

400

There was a validation error.

403

Invalid authentication

Get Asset Folder

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}

Get an Asset Folder.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

foldertruestring

Folder ID.

Responses

200

Success

Example application/json
{
  "folder": {
    "id": "1",
    "children": [
      "2",
      "3"
    ],
    "label": "My Folder",
    "path": "/",
    "inherit": false
  }
}
400

There was a validation error.

403

Invalid authentication

List Asset Folder Permissions

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/permissions

List Permissions for an AssetFolder.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

foldertruestring

Folder ID.

Responses

200

Success

Example application/json
{
  "permissions": [
    {
      "id": "1",
      "rId": "urn:livefyre:example.fyre.co:assetLibrary=example.fyre.co:assetFolder=1",
      "rType": "assetFolder",
      "operation": "view",
      "role": {
        "id": "asset_folder_owner",
        "name": "Asset Folder Owner"
      },
      "group": null,
      "user": {
        "id": "urn:livefyre:exmaple.fyre.co:user=system",
        "name": "System User"
      }
    }
  ]
}
400

There was a validation error.

403

Invalid authentication

Update Asset Folder Permissions

posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/permissions

Add or remove Permissions for an AssetFolder.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

foldertruestring

Folder ID.

Request Body

Content-Type: application/json

propertytypedescription
createarray
create.[]object

Describes a grant of authorization for some subjects to perform some action on some resource or resource group

create.[].idstring
create.[].rTypestring

Resource Type

create.[].operationstring
create.[].rIdstring

Resource ID Pattern to which the permission applies

create.[].roleobject
create.[].groupstringnull
create.[].userobject
removearray
remove.[]object

Describes a grant of authorization for some subjects to perform some action on some resource or resource group

remove.[].idstring
remove.[].rTypestring

Resource Type

remove.[].operationstring
remove.[].rIdstring

Resource ID Pattern to which the permission applies

remove.[].roleobject
remove.[].groupstringnull
remove.[].userobject

Responses

200

Success

400

There was a validation error.

403

Invalid authentication

Update Folder Assets

posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/folder/{folder}/assets

Add or remove Assets from an Asset Folder

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

foldertruestring

Folder ID.

Request Body

Content-Type: application/json

propertytypedescription
assignarray

Asset IDs to add to the Folder.

assign.[]string
removearray

Asset IDs to remove from the Folder.

remove.[]string

Responses

200

Success

Example application/json
{
  "assign": [
    {
      "id": "1",
      "status": 200
    }
  ]
}
400

There was a validation error.

403

Invalid authentication

Get Library Attributes

gethttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/attributes

Search for attributes that have been assigned to Assets in the Library.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Query Parameters
namerequiredtypedescription
keytruestring

The key to retrieve Attributes for.

Responses

200

Successful search.

Example application/json
{
  "attributes": [
    {
      "key": "tag",
      "value": "photo"
    }
  ]
}
400

There was a validation error.

403

Invalid authentication

Update Asset Attributes

posthttp://{networkName}.admin.fyre.co/services/frontline/api/v4/assetManager//{network}/assetLibrary/{library}/attributes

Add or remove Attributes from Assets.

Path Parameters
namerequiredtypedescription
networktruestring

Livefyre Network ID.

librarytruestring

Livefyre Asset Library ID. Every network has a default Asset Library with the same ID as the network.

Request Body

Content-Type: application/json

propertytypedescription
assetsarray

IDs of the Assets to modify.

assets.[]string
addarray

Add this Attribute.

add.[]object
add.[].keystring

The type of the attribute.

add.[].valuestring

The value of the attribute.

setarray

Remove all Attributes with this key and add this Attribute.

set.[]object
set.[].keystring

The type of the attribute.

set.[].valuestring

The value of the attribute.

removearray

Remove this Attribute.

remove.[]object
remove.[].keystring

The type of the attribute.

remove.[].valuestring

The value of the attribute.

Responses

200

Success.

400

There was a validation error.

403

Invalid authentication