API Reference
SDKsSample appsIntegrationsDiscordPlayground

The video object

The video object has the following fields:

  • _id: A string representing the unique identifier of a video vector. The API service creates a new video vector object and assigns it a unique identifier when the video has successfully been indexed, and it's ready to be searched. Note that video IDs are different from task IDs.
  • created_at: A string indicating the date and time, in the RFC 3339 format, that the video indexing task was created.
  • indexed_at: A string indicating the date and time, in the RFC 3339 format, that the video has finished indexing.
  • metadata: An object that contains the following information about the video:
    • duration
    • filename
    • fps
    • height
    • size
    • width
    • Any custom metadata you've specified by calling the PUT method of the /indexes/:index-id/videos/:video-id endpoint.
  • hls: The platform returns this object only for the videos that you uploaded with the disable_video_stream parameter set to false. This object has the following properties:
    • video_url: A string representing the URL of the video. You can use this URL to access the stream over the HLS protocol.
    • thumbnail_urls: An array containing the URL of the thumbnail.
    • status: A string representing the encoding status of the video file from its original format to a streamable format.
    • updated_at: A string indicating the date and time, in the RFC 3339 format, that the encoding status was last updated.
  • updated_at: A string indicating the date and time, in the RFC 3339 format, that the video indexing task object was last updated. The API service updates this field every time the video indexing task transitions to a different state.