CLcloudglue
Collections

Retrieve extracted entities for a specific file in a collection

Changed on

Retrieve extracted entities for a specific file in a collection. Results are paginated with a default limit of 50 segment entities per request (maximum 100). Use limit and offset parameters to paginate through all results. This API is only available when the collection is created with collection_type 'entities'

get/collections/{collection_id}/videos/{file_id}/entities

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Path parameters

collection_idstring required

The ID of the collection

file_idstring required

The ID of the file

Query parameters

limitinteger

Maximum number of segment entities to return

offsetinteger

Number of segment entities to skip

include_thumbnailsboolean

When true, include a file-level thumbnail_url in the response and a per-segment thumbnail_url on each segment entity

include_chaptersboolean

Include narrative chapters in the response (when segmentation strategy is 'narrative')

include_shotsboolean

Include shot boundaries in the response (when segmentation strategy is 'shot-detector')

Response

File entities

collection_idstring required

ID of the collection

file_idstring required

ID of the file

thumbnail_urlstring uri

URL of the file-level thumbnail for the video. Only present when include_thumbnails=true.

entitiesobject required

Entities extracted from the file at the video level

totalinteger required

Total number of segment entities available

limitinteger required

Maximum number of entities returned per request

offsetinteger required

Number of entities skipped

total_chaptersinteger

Total number of chapters (only present when include_chapters=true and segmentation strategy is 'narrative')

total_shotsinteger

Total number of shots (only present when include_shots=true and segmentation strategy is 'shot-detector')

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1d5d6115c0d0Revision changes
    • breaking

      for the query request parameter include_thumbnails, default value false was removed

    • breaking

      for the query request parameter limit, default value 50 was removed

    • breaking

      for the query request parameter offset, default value 0 was removed

    • info

      added the new optional query request parameter include_chapters

    • info

      added the new optional query request parameter include_shots

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status