Skip to main content
GET
/
collections
/
{collection_id}
/
videos
/
{file_id}
/
entities
Retrieve extracted entities for a specific file in a collection
curl --request GET \
  --url https://api.cloudglue.dev/v1/collections/{collection_id}/videos/{file_id}/entities \
  --header 'Authorization: Bearer <token>'
{
  "collection_id": "<string>",
  "file_id": "<string>",
  "entities": {},
  "segment_entities": [
    {
      "start_time": 123,
      "end_time": 123,
      "entities": {}
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
For details on how to create a video collection, see Create Collection

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
collection_id
string
required

The ID of the collection

​
file_id
string
required

The ID of the file

Query Parameters

​
limit
integer
default:50

Maximum number of segment entities to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of segment entities to skip

Required range: x >= 0

Response

File entities

​
collection_id
string
required

ID of the collection

​
file_id
string
required

ID of the file

​
entities
object
required

Entities extracted from the file at the video level

​
segment_entities
object[]
required

Array of video entities extracted from individual time segments

​
total
integer
required

Total number of segment entities available

​
limit
integer
required

Maximum number of entities returned per request

​
offset
integer
required

Number of entities skipped