Content Pool API Introduction

The Content Pool API allows your third-party software tool to access information relating to the Content Pool in your Falcon organization. Using the Content Pool API, you can search, add, edit, or delete stock items in the Content Pool.

Note:

This article offers an introduction to the Falcon Content Pool API. For more information, please visit Falcon’s API Technical Documentation here. Don’t yet have access to Falcon APIs? Find out how to get access here.

What Features Are Available?

There are 14 endpoints available in the Content Pool API:

  • Search Stocks
  • Create an Empty Stock
  • Create a Stock with Assets
  • Archive a Stock
  • Edit a Stock
  • Get a Stock
  • Delete a Stock
  • Get Stock Labels
  • Add Labels to a Stock
  • Remove Labels from a Stock
  • Add a New Asset to a Stock
  • Edit an Asset
  • Get an Asset
  • Get All Assets by Stock ID
  • Delete an Asset

Note: For help location a Stock ID or an Asset ID for use with any of the below endpoints, please visit the guides below: Stock ID, Asset ID.

Stocks

Search Stocks

Using the Search Stocks endpoint, you can retrieve a list of stock items from your Content Pool which match your search criteria. You can limit your search by: ID, dates, type of media, status, text, number of cards, labels, and more.

Create an Empty Stock

Create an empty stock item in the Content Pool containing only a title and (if applicable) an embargo and expiration date.

Following the creation, you will receive information about the new empty stock item, including an ID, allowing you to add to the stock item at a later date if needed.

Create a Stock with Assets

Using the Create a Stock with assets endpoint, you can create a new stock item, including a title, embargo and expiration date, and media files.

Archive a Stock

Choose to archive any existing stock item using the Stock ID. Currently, only users with a user role of Admin can archive stock items. Similarly, only Admin users can retrieve previously archived stock items.

Edit a Stock

Edit the title, embargo date, or expiration date of any existing stock item using the Stock ID. It’s not possible to edit a stock item’s media using the edit a stock endpoint.

Get a Stock

Using a Stock ID, you can retrieve information about any stock item, including the title, embargo date, expiration date, status, creation date, and number of copies.

Delete a Stock

Using a Stock ID, you can choose to entirely delete a stock item.

Stock Labels

Get Stock Labels

Using a Stock ID, find out which labels have been applied to any existing stock item.

Add Labels to a Stock

Using a Stock ID, manually add any number of existing labels to an existing stock item. It’s not possible to add brand new labels with the add labels to a stock endpoint. To add a new label, first you will need to create the label via the Labels API or via the Falcon platform.

Remove Labels from a Stock

Using a Stock ID, manually remove specific labels from the stock item.

Assets

Add a New Asset to a Stock

Using a Stock ID, add a new image, video, text, link, or caption asset to an existing stock item.

Edit an Asset

Using an Asset ID, replace the media by adding an updated image or video.

Get an Asset

Using an Asset ID, find out information relating to the asset such as the Asset ID, Stock ID, creation date, modified date, and media type.

Get All Assets by Stock ID

Using a Stock ID, find out information relating to all assets associated with the stock item. You will receive the same information for each asset as listed above for the get an asset endpoint.

Delete an Asset

Using the Asset ID, permanently remove the asset from the existing stock item.

How Can I Find a Stock ID?

There are two ways you can locate the Stock ID for any existing stock item:

Via the Content Pool API

Using the Search Stocks or Get a Stock endpoint, you can search for matching stock items. Your results will include the Stock ID.

Via the Falcon platform

In Falcon, any user can locate the Stock ID of an existing stock item by clicking on the item in the Content Pool. The ID will be visible in the URL as shown below.

mceclip1.png

How Can I Find an Asset ID?

Though it’s not possible to obtain an Asset ID via the Falcon platform, you can retrieve all Asset IDs associated with any existing stock item using the Get All Assets by Stock ID endpoint above. To use this endpoint, you will need to obtain the Stock ID first using the guide above.

How Can I Use the Content API?

If you decide to integrate Falcon with a Digital Asset Management software tool, you can use the Content Pool API to translate each media file into a stock item in the Falcon Content Pool. Subsequently, content creators in Falcon can utilize the stock items to create content for new posts.

In addition, you could also utilize the Content API in conjunction with a custom dashboard to gather and display information relating to the usage of stock items in the Content Pool, such as the number of copies.

Where Can I Find the Technical Documentation?

For general information and descriptions of the available APIs, check out the Help Center guides here. To view the Falcon API Technical Documentation, please visit: falconio.docs.apiary.io

Was this article helpful?
0 out of 0 found this helpful