Reference: protocol.mediaproxy.v1

Services

MediaProxyService

Harmony service for fetching metadata and generating instant view for URLs. Fields

FetchLinkMetadata

protocol.mediaproxy.v1.FetchLinkMetadataRequest -> protocol.mediaproxy.v1.FetchLinkMetadataResponse

Endpoint to fetch metadata for a URL.


FetchLinkMetadataRequest

Used in the FetchLinkMetadata endpoint.

Fields

url

Type: optional string

URL to fetch metadata from.


FetchLinkMetadataResponse

Used in the FetchLinkMetadata endpoint.

Fields

is_site

Type: optional protocol.mediaproxy.v1.SiteMetadata

Site metadata for the URL.

is_media

Type: optional protocol.mediaproxy.v1.MediaMetadata

Media metadata for the URL.


InstantView

protocol.mediaproxy.v1.InstantViewRequest -> protocol.mediaproxy.v1.InstantViewResponse

Endpoint to instant view a website URL.


InstantViewRequest

Used in the InstantView endpoint.

Fields

url

Type: optional string

URL to get instant view for.


InstantViewResponse

Used in the InstantView endpoint.

Fields

metadata

Type: optional protocol.mediaproxy.v1.SiteMetadata

Site metadata for the URL.

content

Type: optional string

Instant view content.

is_valid

Type: optional bool

Whether the instant view is valid.


CanInstantView

protocol.mediaproxy.v1.CanInstantViewRequest -> protocol.mediaproxy.v1.CanInstantViewResponse

Endpoint to query if the server can generate an instant view for a website URL.


CanInstantViewRequest

Used in the CanInstantView endpoint.

Fields

url

Type: optional string

URL to query if server can instant view the website.


CanInstantViewResponse

Used in the CanInstantView endpoint.

Fields

can_instant_view

Type: optional bool

Whether the server generate an instant view for the URL queried.

Standalone Message Types

SiteMetadata

Object representing the metadata of a website.

Fields

site_title

Type: optional string

Title of the website.

page_title

Type: optional string

Page title of the website page.

kind

Type: optional string

Kind of the website.

description

Type: optional string

Description of the website page.

url

Type: optional string

URL of the website.

image

Type: optional string

A thumbnail image of the website.


MediaMetadata

Object represeting the metadata of a media.

Fields

mimetype

Type: optional string

Mimetype of the media.

filename

Type: optional string

Filename of the media.

size

Type: optional uint32

Sıze of the media.

This should (usually) be the size taken from the Content-Length header (for HTTP requests). If this is not included, then it means the size could not be determined.