Filestack Logo Docs homepage

Copyright Detection

Overview

Copyright Detection is one of the intelligence services of the Filestack platform. You can detect whether your image is copyright protected or not, and if it is protected, all types and related details such as purchase link, etc. would be returned.

Processing API

Copyright Detection is available as a synchronous operation in the Processing API using the following task:

copyright

To use this task in Processing API, you have to use security policy and signature. Read more about security policies here.

Response

  • If your file is not copyright protected:

    {
"copyright": false,
"licenses": []
}

  • If your file is copyright protected:

    {
"copyright": true,
"licenses": [
{
  "imageDetails": {
    "collection": "E+",
    "dateCreated": "2018-07-27T00:00:00",
    "id": "d76cf269-0ad7-4828-ac35-b5dd363e8af4",
    "keywords": "Mature Adult\tApartment\tChild\tPeople\tSmall Group Of People\tLGBTQI People\tDomestic Room\tA Helping Hand\tLifestyles\tEnjoyment\tSon\t8-9 Years\tFun\tKitchen\tMature Men\tHealthy Eating\tPreparing Food\tChildhood\tFood and Drink\tHorizontal\tFamily\t40-49 Years\tMen\tEating\tChores\tAssistance\tSouthern European Descent\tSetting The Table\tPhotography\tAdult\tReal People\tTwo Parents\tOpen Plan\tFather\tTable\t10-11 Years\tHappiness\tMales\tDomestic Life\tGirls\tFemales\tFamily with Two Children\tSpain\tDomestic Kitchen\tDaughter\tGay Man\tBonding\tIndoors\tHomosexual\tDrink\tServing Food and Drinks\tLove - Emotion\tTogetherness\tHealthy Lifestyle\tCopy Space\tParent ",
    "licensingInfo": [
      {
        "imageId": "1044940294",
        "name": "Getty Images",
        "purchaseUrl": "https://www.gettyimages.com/detail/photo/family-eating-together-royalty-free-image/1044940294",
        "types": [
          "Royalty Free"
        ]
      },
      {
        "imageId": "279663302",
        "name": "iStock",
        "purchaseUrl": "https://www.istockphoto.com/photo/lgbtq-family-eating-together-gm1044940294-279663302",
        "types": [
          "Royalty Free"
        ]
      }
    ],
    "photographerName": "ferrantraite",
    "servingUrl": "https://getty-irc-catalog.s3.amazonaws.com/Images/54/d76cf269-0ad7-4828-ac35-b5dd363e8af4.jpg",
    "title": "LGBTQ Family eating together"
  }
}
]
}

Response Parameters
copyright boolean Indicates whether the image is copyright protected or not.
licenses list List of a dictionary, imageDetails, including details regarding the names, types, IDs, and links of detected copyrights in the image. If the image is not copyright protected, the list would be empty.
imageDetails dictionary Details of detected license.
collection string Name of the detected collection in which the image was registered.
dateCreated string The date when the image is registered in the collection.
id string Copyright ID.
keywords string Keywords which the image was tagged with.
licenseInfo list List of licenses attached to the image with details.
imageId string Identification number of the image in the collection database.
name string Name of the license.
purchaseUrl string The link using which the image can be purchased.
type string License type (either one of "Royalty Free" or "Rights Managed").
photographerName string Name of the person/organization to who/which originally captured the image.
servingUrl string The URL link redirecting to the image.
title string Description of the image.

Examples

  • Determine whether your file is copyright protected:

    https://cdn.filestackcontent.com/security=p:<POLICY>,s:<SIGNATURE>/copyright/<HANDLE>

  • Use copyright detection in a chain with other tasks such as resize:

    https://cdn.filestackcontent.com/security=p:<POLICY>,s:<SIGNATURE>/resize=h:<HEIGHT>/copyright/<HANDLE>

  • Use copyright detection with an external URL:

    https://cdn.filestackcontent.com/<FILESTACK_API_KEY>/security=p:<POLICY>,s:<SIGNATURE>/copyright/<EXTERNAL_URL>

  • Use copyright detection with Storage Aliases:

    https://cdn.filestackcontent.com/<FILESTACK_API_KEY>/security=p:<POLICY>,s:<SIGNATURE>/copyright/src://<STORAGE_ALIAS>/<PATH_TO_FILE>

Workflows Task Configuration

Visit Creating Workflows Tutorial to learn how you can use Workflows UI to configure your tasks and logic between them.

Copyright Detection task is available under Intelligence tasks category.

Workflows Parameters
Task Name string Unique name of the task. It will be included in the webhook response and can be used to build logic below.

Logic

Copyright Detection task returns following response:

  • If no copyright information was found:

    {
"data": {
"copyright": false,
"licenses": []
}
}

  • If the copyright information was found:

    {
"data": {
"copyright": true,
"licenses": [
  {
    "imageDetails": {
      "collection": "Getty Images News",
      "dateCreated": "2019-02-05T00:00:00",
      "id": "c86ccb39-45ff-4caf-b55b-56196da31ce8",
      "keywords": "Connection\tGovernment Shutdown\tGovernment\tHand\tNancy Pelosi\tSpeech\tColor Image\tUS President\tUSA\tPolitics and Government\tHorizontal\tPolitics\tPart Of\tWeek\tHandshake\tPhotography\tCapitol Building - Washington DC\tAttached\tDonald Trump - US President\tMike Pence\tHouse Of Representatives\tWashington DC\tVice President ",
      "licensingInfo": [
        {
          "imageId": "1094199740",
          "name": "Getty Images",
          "purchaseUrl": "https://www.gettyimages.com/detail/news-photo/president-donald-trump-shakes-hands-with-speaker-of-the-news-photo/1094199740",
          "types": [
            "Rights Managed"
          ]
        }
      ],
      "photographerName": "Pool",
      "servingUrl": "https://getty-irc-catalog.s3.amazonaws.com/Images/54/c86ccb39-45ff-4caf-b55b-56196da31ce8.jpg",
      "title": "President Trump Delivers State Of The Union Address To Joint Session Of Congress"
    }
  }
]
}
}

Logic Parameters
data dictionary Includes the general response from this service.
copyright boolean Indicates whether the image is copyright protected or not.
licenses list List of a dictionary, imageDetails, including details regarding the names, types, IDs, and links of detected copyrights in the image. If the image is not copyright protected, the list would be empty.
imageDetails dictionary Details of detected license.
collection string Name of the detected collection in which the image was registered.
dateCreated string The date when the image is registered in the collection.
id string Copyright ID.
keywords string Keywords which the image was tagged with.
licenseInfo list List of licenses attached to the image with details.
imageId string Identification number of the image in the collection database.
name string Name of the license.
purchaseUrl string The link using which the image can be purchased.
type string License type (either one of "Royalty Free" or "Rights Managed").
photographerName string Name of the person/organization to who/which originally captured the image.
servingUrl string The URL link redirecting to the image.
title string Description of the image.

Based on the task’s response you can build logic that tells the workflow how dependent tasks should be executed. For example, if you would like to run another task if a copyright was detected you can use following rule:

copyright eq true

In Workflows UI this command would look like in the example below:

Visit Creating Workflows Tutorial to learn how you can use Workflows UI to configure your tasks and logic between them.

Webhook

Below you can find an example webhook payload for a copyright detection task

  • no copyright detected

    {
"id": 65402771,
"action": "fs.workflow",
"timestamp": 1551136622,
"text": {
    "workflow": "c516519f-3755-4fb5-85a4-15ae4b31d475",
    "createdAt": "2019-02-25T23:16:23.010750424Z",
    "updatedAt": "2019-02-25T23:16:25.900202482Z",
    "sources": [
        "bpX6N2WQMqJnpOSPBPGS"
    ],
    "results": {
        "copyright_1551136380097": {
            "data": {
                "copyright": false,
                "licenses": []
            }
        }
    },
    "status": "Finished"
}
}

  • copyright detected

    {
"id": 65403144,
"action": "fs.workflow",
"timestamp": 1551137102,
"text": {
    "workflow": "c516519f-3755-4fb5-85a4-15ae4b31d475",
    "createdAt": "2019-02-25T23:18:57.613519651Z",
    "updatedAt": "2019-02-25T23:19:00.060465132Z",
    "sources": [
        "wcbJxfkFQ6Y0Ul0O82LS"
    ],
    "results": {
        "copyright_1551136380097": {
            "data": {
                "copyright": true,
                "licenses": [
                    {
                        "imageDetails": {
                            "collection": "Getty Images News",
                            "dateCreated": "2019-02-05T00:00:00",
                            "id": "c86ccb39-45ff-4caf-b55b-56196da31ce8",
                            "keywords": "Connection\tGovernment Shutdown\tGovernment\tHand\tNancy Pelosi\tSpeech\tColor Image\tUS President\tUSA\tPolitics and Government\tHorizontal\tPolitics\tPart Of\tWeek\tHandshake\tPhotography\tCapitol Building - Washington DC\tAttached\tDonald Trump - US President\tMike Pence\tHouse Of Representatives\tWashington DC\tVice President ",
                            "licensingInfo": [
                                {
                                    "imageId": "1094199740",
                                    "name": "Getty Images",
                                    "purchaseUrl": "https://www.gettyimages.com/detail/news-photo/president-donald-trump-shakes-hands-with-speaker-of-the-news-photo/1094199740",
                                    "types": [
                                        "Rights Managed"
                                    ]
                                }
                            ],
                            "photographerName": "Pool",
                            "servingUrl": "https://getty-irc-catalog.s3.amazonaws.com/Images/54/c86ccb39-45ff-4caf-b55b-56196da31ce8.jpg",
                            "title": "President Trump Delivers State Of The Union Address To Joint Session Of Congress"
                        }
                    }
                ]
            }
        }
    },
    "status": "Finished"
}
}

Please visit the webhooks documentation page to learn more.