Search documentation
karat

+

K

User Documentation ↗

Read Media Content

GET/api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets the content of a media item referenced by this property.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:mediasets-read.

Path parameters

ontology
string

The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.

objectType
string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

primaryKey
string

The primary key of the object with the media reference property.

property
string

The API name of the media reference property. To find the API name, check the Ontology Manager or use the Get object type endpoint.

Query parameters

artifactRepository
string
optional

The repository associated with a marketplace installation.

packageName
string
optional

The package name of the generated SDK.

preview
boolean
optional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

body
string

The content stream.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objects/employee/50030/media/profile_picture/content?preview=true"