veritone_dmh.RenditionTypesApi

All URIs are relative to https://localhost/assets-api

Method	HTTP request	Description
available_renditions	GET /v1/renditionType/availableRenditions/{assetId}	Retrieve a map of available renditions for a clip.
clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id	GET /v1/renditionType/clipDetail/{assetId}/{parent}/{parentId}	Retrieve clip metadata based on access privilege of parent entity of asset.
find_rendition	GET /v1/renditionType/{assetId}	Retrieve a single rendition URL for a particular use type.
find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id	GET /v1/renditionType/{assetId}/quote/{quoteId}	Retrieve a single rendition URL for a particular use type.
get_asset_delivery_options	GET /v1/renditionType/deliveryOptions/{assetId}	Retrieve the url to download comp.
get_asset_delivery_options_by_parent	GET /v1/renditionType/deliveryOptions/{assetId}/{parent}/{parentId}	Retrieve the url to download comp based on access to specified parent entity.
get_cart_asset_delivery_options	GET /v1/renditionType/cartDeliveryOptions	Retrieve the url to download comp.
get_clip_detail	GET /v1/renditionType/clipDetail/{assetId}	Retrieve the URL used to render a rendition. The siteName query parameter is optional and only required for anonymous users.
get_comp_aspera_spec	GET /v1/renditionType/asperaSpec/{assetId}	Retrieve the asperaSpec for a rendition type.
get_comp_download_url	GET /v1/renditionType/downloadUrl/{assetId}	Retrieve a download URL for a rendition type.
get_delivery_options_for_current_user	GET /v1/renditionType/myDeliveryOptions	Retrieve delivery options for the current user
get_eligible_assets_for_delivery_option	GET /v1/renditionType/deliveryOptions/eligibleAssets	return asset ids that are valid for the specified delivery option
get_line_item_spec_list_for_order	GET /v1/renditionType/order/specs/{orderId}	Retrieve the url to download the lineItem transcodes for order.
get_line_item_url	GET /v1/renditionType/order/{orderId}/lineItem/{lineItemId}	Retrieve the url to download the lineItem transcode.
get_line_item_urls_for_order	GET /v1/renditionType/order/{orderId}	Retrieve the url to download the lineItem transcodes for order.

available_renditions

dict(str, object) available_renditions(asset_id, is_mobile=is_mobile, browser_type=browser_type)

Retrieve a map of available renditions for a clip.

Required Permissions: There are no required permissions for this endpoint. Developer Information: The response will include temporary URLs to the available renditions. Availability is determined by CORE workflow rules.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
is_mobile = true # bool |  (optional)
browser_type = 'browser_type_example' # str | The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox. (optional)

try:
    # Retrieve a map of available renditions for a clip.
    api_response = api_instance.available_renditions(asset_id, is_mobile=is_mobile, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->available_renditions: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
is_mobile	bool		[optional]
browser_type	str	The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox.	[optional]

Return type

dict(str, object)

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id

AssetDetail clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id(asset_id, parent, parent_id)

Retrieve clip metadata based on access privilege of parent entity of asset.

Required Permissions: ViewClips Developer Information: Returns the clipData fields and preview rendition URLs for a single clip that belongs to the specified parent entity (collection/quote/order). The asset detail and rendition type configuration define which clipData and rendition values are returned.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | Clip id
parent = 'parent_example' # str | Parent entity type
parent_id = 789 # int | Parent entity Id

try:
    # Retrieve clip metadata based on access privilege of parent entity of asset.
    api_response = api_instance.clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id(asset_id, parent, parent_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id: %s\n" % e)

Parameters

Name	Type	Description
asset_id	int	Clip id
parent	str	Parent entity type
parent_id	int	Parent entity Id

Return type

AssetDetail

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_rendition

RenditionUrl find_rendition(asset_id, use_type=use_type, is_mobile=is_mobile, browser_type=browser_type)

Retrieve a single rendition URL for a particular use type.

Required Permissions: There are no required permissions for this endpoint. Developer Information: The response will include a temporary URL to the available rendition. URL availability may vary by use type, and is based on the rendition type configuration.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
use_type = 'use_type_example' # str | The use type for which the URL is needed. Supported types are thumbnail, clipThumbnail, clipQuickPreview, clipPreview, imagePreview, imageCompDownload, cleanClipCompDownload, and cleanImageCompDownload. (optional)
is_mobile = true # bool |  (optional)
browser_type = 'browser_type_example' # str | The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox. (optional)

try:
    # Retrieve a single rendition URL for a particular use type.
    api_response = api_instance.find_rendition(asset_id, use_type=use_type, is_mobile=is_mobile, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->find_rendition: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
use_type	str	The use type for which the URL is needed. Supported types are thumbnail, clipThumbnail, clipQuickPreview, clipPreview, imagePreview, imageCompDownload, cleanClipCompDownload, and cleanImageCompDownload.	[optional]
is_mobile	bool		[optional]
browser_type	str	The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox.	[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id

RenditionUrl find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id(asset_id, quote_id, use_type=use_type, is_mobile=is_mobile, browser_type=browser_type)

Retrieve a single rendition URL for a particular use type.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
quote_id = 789 # int | Quote Id
use_type = 'use_type_example' # str | The use type for which the URL is needed. Supported types are thumbnail, clipThumbnail, clipQuickPreview, clipPreview, imagePreview, imageCompDownload, cleanClipCompDownload, and cleanImageCompDownload. (optional)
is_mobile = true # bool |  (optional)
browser_type = 'browser_type_example' # str | The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox. (optional)

try:
    # Retrieve a single rendition URL for a particular use type.
    api_response = api_instance.find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id(asset_id, quote_id, use_type=use_type, is_mobile=is_mobile, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
quote_id	int	Quote Id
use_type	str	The use type for which the URL is needed. Supported types are thumbnail, clipThumbnail, clipQuickPreview, clipPreview, imagePreview, imageCompDownload, cleanClipCompDownload, and cleanImageCompDownload.	[optional]
is_mobile	bool		[optional]
browser_type	str	The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox.	[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_asset_delivery_options

ApiList get_asset_delivery_options(asset_id, browser_type=browser_type, site_name=site_name)

Retrieve the url to download comp.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
browser_type = 'browser_type_example' # str | Browser types: Any, Chrome, Edge, Safari, Firefox, Opera, IE  (optional)
site_name = 'site_name_example' # str |  (optional)

try:
    # Retrieve the url to download comp.
    api_response = api_instance.get_asset_delivery_options(asset_id, browser_type=browser_type, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_asset_delivery_options: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
browser_type	str	Browser types: Any, Chrome, Edge, Safari, Firefox, Opera, IE	[optional]
site_name	str		[optional]

Return type

ApiList

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json; charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_asset_delivery_options_by_parent

ApiList get_asset_delivery_options_by_parent(asset_id, parent, parent_id, browser_type=browser_type)

Retrieve the url to download comp based on access to specified parent entity.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
parent = 'parent_example' # str | Parent entity type
parent_id = 789 # int | Parent entity Id
browser_type = 'browser_type_example' # str | Browser types: Any, Chrome, Edge, Safari, Firefox, Opera, IE  (optional)

try:
    # Retrieve the url to download comp based on access to specified parent entity.
    api_response = api_instance.get_asset_delivery_options_by_parent(asset_id, parent, parent_id, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_asset_delivery_options_by_parent: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
parent	str	Parent entity type
parent_id	int	Parent entity Id
browser_type	str	Browser types: Any, Chrome, Edge, Safari, Firefox, Opera, IE	[optional]

Return type

ApiList

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cart_asset_delivery_options

RenditionUrl get_cart_asset_delivery_options(assets, site_name=site_name)

Retrieve the url to download comp.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
assets = 'assets_example' # str | Comma Separated list of assets to retrieve
site_name = 'site_name_example' # str |  (optional)

try:
    # Retrieve the url to download comp.
    api_response = api_instance.get_cart_asset_delivery_options(assets, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_cart_asset_delivery_options: %s\n" % e)

Parameters

Name	Type	Description	Notes
assets	str	Comma Separated list of assets to retrieve
site_name	str		[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_clip_detail

RenditionUrl get_clip_detail(asset_id, site_name=site_name)

Retrieve the URL used to render a rendition. The siteName query parameter is optional and only required for anonymous users.

Required Permissions: There are no required permissions for this endpoint. Developer Information: The response will include a URL that may be used to render the asset on screen. For videos, it will be a URL that can be fed directly to JWPlayer. For images/pdf, it will be a base64 data URL)

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
site_name = 'site_name_example' # str |  (optional)

try:
    # Retrieve the URL used to render a rendition. The siteName query parameter is optional and only required for anonymous users.
    api_response = api_instance.get_clip_detail(asset_id, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_clip_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
site_name	str		[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_comp_aspera_spec

RenditionUrl get_comp_aspera_spec(asset_id, type, browser_type=browser_type)

Retrieve the asperaSpec for a rendition type.

Required Permissions: There are no required permissions for this endpoint. Developer Information: The asperaSpec can be used to initiate an accelerated rendition transfer. Aspera availability may vary by rendition type.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
type = 'type_example' # str | The rendition type for which the download URL is needed. Supported types are wm, clean, or full.
browser_type = 'browser_type_example' # str | The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox. (optional)

try:
    # Retrieve the asperaSpec for a rendition type.
    api_response = api_instance.get_comp_aspera_spec(asset_id, type, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_comp_aspera_spec: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
type	str	The rendition type for which the download URL is needed. Supported types are wm, clean, or full.
browser_type	str	The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox.	[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_comp_download_url

RenditionUrl get_comp_download_url(asset_id, type, browser_type=browser_type)

Retrieve a download URL for a rendition type.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
asset_id = 789 # int | 
type = 'type_example' # str | The rendition type for which the download URL is needed. Supported types are wm, clean, or full.
browser_type = 'browser_type_example' # str | The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox. (optional)

try:
    # Retrieve a download URL for a rendition type.
    api_response = api_instance.get_comp_download_url(asset_id, type, browser_type=browser_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_comp_download_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	int
type	str	The rendition type for which the download URL is needed. Supported types are wm, clean, or full.
browser_type	str	The browser type. Supported types are Any, Chrome, Edge, Safari, and Firefox.	[optional]

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_delivery_options_for_current_user

list[object] get_delivery_options_for_current_user(transfer_type=transfer_type)

Retrieve delivery options for the current user

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
transfer_type = 'transfer_type_example' # str | an optional transferType parameter (optional)

try:
    # Retrieve delivery options for the current user
    api_response = api_instance.get_delivery_options_for_current_user(transfer_type=transfer_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_delivery_options_for_current_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
transfer_type	str	an optional transferType parameter	[optional]

Return type

list[object]

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_eligible_assets_for_delivery_option

get_eligible_assets_for_delivery_option(delivery_option_id, ids, site_name=site_name)

return asset ids that are valid for the specified delivery option

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
delivery_option_id = 'delivery_option_id_example' # str | delivery option id
ids = 'ids_example' # str | Comma Separated list of asset IDs to validate against a delivery option id
site_name = 'site_name_example' # str |  (optional)

try:
    # return asset ids that are valid for the specified delivery option
    api_instance.get_eligible_assets_for_delivery_option(delivery_option_id, ids, site_name=site_name)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_eligible_assets_for_delivery_option: %s\n" % e)

Parameters

Name	Type	Description	Notes
delivery_option_id	str	delivery option id
ids	str	Comma Separated list of asset IDs to validate against a delivery option id
site_name	str		[optional]

Return type

void (empty response body)

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_line_item_spec_list_for_order

str get_line_item_spec_list_for_order(order_id)

Retrieve the url to download the lineItem transcodes for order.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
order_id = 789 # int | 

try:
    # Retrieve the url to download the lineItem transcodes for order.
    api_response = api_instance.get_line_item_spec_list_for_order(order_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_line_item_spec_list_for_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	int

Return type

str

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_line_item_url

RenditionUrl get_line_item_url(order_id, line_item_id)

Retrieve the url to download the lineItem transcode.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
order_id = 789 # int | 
line_item_id = 'line_item_id_example' # str | 

try:
    # Retrieve the url to download the lineItem transcode.
    api_response = api_instance.get_line_item_url(order_id, line_item_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_line_item_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	int
line_item_id	str

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_line_item_urls_for_order

RenditionUrl get_line_item_urls_for_order(order_id)

Retrieve the url to download the lineItem transcodes for order.

Required Permissions: There are no required permissions for this endpoint. Developer Information: There is no developer information provided for this endpoint.

Example

from __future__ import print_function
import time
import veritone_dmh
from veritone_dmh.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyQuery
configuration = veritone_dmh.Configuration()
configuration.api_key['api_key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# create an instance of the API class
api_instance = veritone_dmh.RenditionTypesApi(veritone_dmh.ApiClient(configuration))
order_id = 789 # int | 

try:
    # Retrieve the url to download the lineItem transcodes for order.
    api_response = api_instance.get_line_item_urls_for_order(order_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RenditionTypesApi->get_line_item_urls_for_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	int

Return type

RenditionUrl

Authorization

ApiKeyQuery

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

RenditionTypesApi.md

Latest commit

History

RenditionTypesApi.md

File metadata and controls

veritone_dmh.RenditionTypesApi

available_renditions

Example

Parameters

Return type

Authorization

HTTP request headers

clip_in_collection_detail_get_v1_rendition_type_clip_detail_by_asset_id_by_parent_by_parent_id

Example

Parameters

Return type

Authorization

HTTP request headers

find_rendition

Example

Parameters

Return type

Authorization

HTTP request headers

find_rendition_get_v1_rendition_type_by_asset_id_quote_by_quote_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_asset_delivery_options

Example

Parameters

Return type

Authorization

HTTP request headers

get_asset_delivery_options_by_parent

Example

Parameters

Return type

Authorization

HTTP request headers

get_cart_asset_delivery_options

Example

Parameters

Return type

Authorization

HTTP request headers

get_clip_detail

Example

Parameters

Return type

Authorization

HTTP request headers

get_comp_aspera_spec

Example

Parameters

Return type

Authorization

HTTP request headers

get_comp_download_url

Example

Parameters

Return type

Authorization

HTTP request headers

get_delivery_options_for_current_user

Example

Parameters

Return type

Authorization

HTTP request headers

get_eligible_assets_for_delivery_option

Example

Parameters

Return type

Authorization

HTTP request headers

get_line_item_spec_list_for_order