ClipApi.md

veritone_dmh.ClipApi

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

Method	HTTP request	Description
asset_indexing	PUT /v1/clip/index/clipIds	Request manual indexing of assets by asset Ids
asset_share	POST /v1/clip/share	Share assets with other users.
clip_collection_edit	GET /v1/clip/{id}/collectionEdit	Retrieve editable clip fields for a collection based on configuration.
clip_create	POST /v1/clip	Create a clip.
clip_delivery_metadata_get	GET /v1/clip/{id}/deliveryMetadata/{deliveryMetadataId}	Retrieve a clip delivery metadata.
clip_get	GET /v1/clip/cacheStats	Retrieve clip metadata and renditions.
clip_get_delivery_options	GET /v1/clip/{id}/share/deliveryOptions	Retrieve clip delivery options.
clip_get_detail	GET /v1/clip/{id}/clipDetail	Retrieve clip metadata based on configuration.
clip_get_edit	GET /v1/clip/{id}/clipEdit	Retrieve editable clip fields based on configuration.
clip_get_get_v1_clip_by_id	GET /v1/clip/{id}	Retrieve clip metadata and renditions.
clip_in_collection_detail	GET /v1/clip/{id}/{parent}/{parentId}/clipDetail	Retrieve clip metadata based on access privilege of parent entity of asset.
clip_list	GET /v1/clip/byIds	Get a list of clips.
clip_update	PUT /v1/clip/{id}	Update an existing clip.
collection_update	PUT /v1/clip/{id}/collectionEdit	Update existing clips in a collection
create_child_clip	POST /v1/clip/child	Create a child clip from an existing clip.
create_rendition_for_clip	PUT /v1/clip/{id}/rendition	Create a rendition for a clip
create_rendition_for_clip_by_core	POST /v1/clip/{id}/renditionInstall	Create a rendition for a clip
delete_rendition_for_clip	DELETE /v1/clip/{id}/rendition/{renditionId}	Delete a rendition for a clip
get_asset_edit_detail	GET /v1/clip/fieldDefinition	Retrieve the field definition for the specified field.
invalidate_cache	PUT /v1/clip/invalidateCache	Invalidate caches in the app.
remove_clips_from_content_owners_inventory	PUT /v1/clip/remove/clipIds	Remove clips from content owner's inventory
watermark	PUT /v1/clip/watermark/image/{id}	Retrieve watermarked rendition of specified clip.

asset_indexing

Response asset_indexing(ids)

Request manual indexing of assets by asset Ids

Required Permissions: IndexClips Developer Information: For each asset id that is submitted, all defined solr indexers will freshly index the metadata.

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.ClipApi(veritone_dmh.ApiClient(configuration))
ids = 'ids_example' # str | Comma separated list of ids to index

try:
    # Request manual indexing of assets by asset Ids
    api_response = api_instance.asset_indexing(ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->asset_indexing: %s\n" % e)

Parameters

Name	Type	Description	Notes
ids	str	Comma separated list of ids to index

Return type

Response

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]

asset_share

asset_share(body=body)

Share assets with other users.

Required Permissions: CreateClipShare 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.ClipApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.AssetShareInfo() # AssetShareInfo |  (optional)

try:
    # Share assets with other users.
    api_instance.asset_share(body=body)
except ApiException as e:
    print("Exception when calling ClipApi->asset_share: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	AssetShareInfo		[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]

clip_collection_edit

AssetEditDetail clip_collection_edit(id, site_name=site_name)

Retrieve editable clip fields for a collection based on configuration.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the clipData fields that can be edited for clips in a collection.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip id
site_name = 'site_name_example' # str | Name of site where asset is located (optional)

try:
    # Retrieve editable clip fields for a collection based on configuration.
    api_response = api_instance.clip_collection_edit(id, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_collection_edit: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip id
site_name	str	Name of site where asset is located	[optional]

Return type

AssetEditDetail

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_create

Clip clip_create(body=body)

Create a clip.

Required Permissions: CreateClips 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.ClipApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.NewClipRequest() # NewClipRequest |  (optional)

try:
    # Create a clip.
    api_response = api_instance.clip_create(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	NewClipRequest		[optional]

Return type

Clip

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_delivery_metadata_get

UpdateMetadataObj clip_delivery_metadata_get(id, delivery_metadata_id)

Retrieve a clip delivery metadata.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the updateMetadata object that reflects the combination of the config and the clip metadata.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
delivery_metadata_id = 789 # int | DeliveryMetadata Id

try:
    # Retrieve a clip delivery metadata.
    api_response = api_instance.clip_delivery_metadata_get(id, delivery_metadata_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_delivery_metadata_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
delivery_metadata_id	int	DeliveryMetadata Id

Return type

UpdateMetadataObj

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_get

Clip clip_get()

Retrieve clip metadata and renditions.

Required Permissions: Root Developer Information: Returns the clipData fields and preview rendition URLs for a single clip. The fields parameter allows the return of a specific set of clipData fields.

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.ClipApi(veritone_dmh.ApiClient(configuration))

try:
    # Retrieve clip metadata and renditions.
    api_response = api_instance.clip_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Clip

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_get_delivery_options

ApiList clip_get_delivery_options(id)

Retrieve clip delivery options.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the appropriate share delivery options for a clip.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id

try:
    # Retrieve clip delivery options.
    api_response = api_instance.clip_get_delivery_options(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_get_delivery_options: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id

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]

clip_get_detail

AssetDetail clip_get_detail(id, time_format=time_format, site_name=site_name)

Retrieve clip metadata based on configuration.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the clipData fields and preview rendition URLs for a single clip. 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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip id
time_format = 'time_format_example' # str | Time Format (optional)
site_name = 'site_name_example' # str | Name of site where asset is located (optional)

try:
    # Retrieve clip metadata based on configuration.
    api_response = api_instance.clip_get_detail(id, time_format=time_format, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_get_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip id
time_format	str	Time Format	[optional]
site_name	str	Name of site where asset is located	[optional]

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]

clip_get_edit

AssetEditDetail clip_get_edit(id, site_name=site_name)

Retrieve editable clip fields based on configuration.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the clipData fields that can be edited for a single clip.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip id
site_name = 'site_name_example' # str | Name of site where asset is located (optional)

try:
    # Retrieve editable clip fields based on configuration.
    api_response = api_instance.clip_get_edit(id, site_name=site_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_get_edit: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip id
site_name	str	Name of site where asset is located	[optional]

Return type

AssetEditDetail

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_get_get_v1_clip_by_id

Clip clip_get_get_v1_clip_by_id(id, fields=fields, site_name=site_name, time_format=time_format)

Retrieve clip metadata and renditions.

Required Permissions: There are no required permissions for this endpoint. Developer Information: Returns the clipData fields and preview rendition URLs for a single clip. The fields parameter allows the return of a specific set of clipData fields.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
fields = 'fields_example' # str | Comma separted list of fields to return (optional)
site_name = 'site_name_example' # str | Name of site where asset is located (optional)
time_format = 'time_format_example' # str | Time Format (optional)

try:
    # Retrieve clip metadata and renditions.
    api_response = api_instance.clip_get_get_v1_clip_by_id(id, fields=fields, site_name=site_name, time_format=time_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_get_get_v1_clip_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
fields	str	Comma separted list of fields to return	[optional]
site_name	str	Name of site where asset is located	[optional]
time_format	str	Time Format	[optional]

Return type

Clip

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

AssetDetail clip_in_collection_detail(id, parent, parent_id, time_format=time_format)

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip id
parent = 'parent_example' # str | Parent entity type
parent_id = 789 # int | Parent entity Id
time_format = 'time_format_example' # str | Time Format (optional)

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

Parameters

Name	Type	Description	Notes
id	int	Clip id
parent	str	Parent entity type
parent_id	int	Parent entity Id
time_format	str	Time Format	[optional]

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]

clip_list

ApiList clip_list(ids, fields=fields, site_name=site_name, time_format=time_format)

Get a list of clips.

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.ClipApi(veritone_dmh.ApiClient(configuration))
ids = 'ids_example' # str | Comma separated list of ids to retrieve
fields = 'fields_example' # str | Comma separated list of fields to return (optional)
site_name = 'site_name_example' # str | Name of site where asset is located (optional)
time_format = 'time_format_example' # str | Time Format (optional)

try:
    # Get a list of clips.
    api_response = api_instance.clip_list(ids, fields=fields, site_name=site_name, time_format=time_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
ids	str	Comma separated list of ids to retrieve
fields	str	Comma separated list of fields to return	[optional]
site_name	str	Name of site where asset is located	[optional]
time_format	str	Time Format	[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]

clip_update

Clip clip_update(id, site_name=site_name, body=body)

Update an existing clip.

Required Permissions: EditClips 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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | 
site_name = 'site_name_example' # str | Name of site where asset is being edited from (optional)
body = veritone_dmh.Clip() # Clip |  (optional)

try:
    # Update an existing clip.
    api_response = api_instance.clip_update(id, site_name=site_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->clip_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
site_name	str	Name of site where asset is being edited from	[optional]
body	Clip		[optional]

Return type

Clip

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]

collection_update

CollectionMetadataUpdateResponse collection_update(id, site_name=site_name, body=body)

Update existing clips in a collection

Required Permissions: EditClips 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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | 
site_name = 'site_name_example' # str | Name of site where collection is being edited from (optional)
body = veritone_dmh.Clip() # Clip |  (optional)

try:
    # Update existing clips in a collection
    api_response = api_instance.collection_update(id, site_name=site_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->collection_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
site_name	str	Name of site where collection is being edited from	[optional]
body	Clip		[optional]

Return type

CollectionMetadataUpdateResponse

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]

create_child_clip

Clip create_child_clip(site_name=site_name, collection_id=collection_id, body=body)

Create a child clip from an existing clip.

Required Permissions: CreateChildClips 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.ClipApi(veritone_dmh.ApiClient(configuration))
site_name = 'site_name_example' # str | Name of site where parent asset is located (optional)
collection_id = 789 # int | Id of collection to add child clip to (optional)
body = veritone_dmh.ChildClipRequest() # ChildClipRequest |  (optional)

try:
    # Create a child clip from an existing clip.
    api_response = api_instance.create_child_clip(site_name=site_name, collection_id=collection_id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->create_child_clip: %s\n" % e)

Parameters

Name	Type	Description	Notes
site_name	str	Name of site where parent asset is located	[optional]
collection_id	int	Id of collection to add child clip to	[optional]
body	ChildClipRequest		[optional]

Return type

Clip

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]

create_rendition_for_clip

Response create_rendition_for_clip(id, body=body)

Create a rendition for a clip

Required Permissions: EditClipRendition Developer Information: The request must contain valid size and purpose. IMPORTANT:The valid size are: full, xlarge, large, medium, small. The valid purpose are: comp, preview, thumbnail, housemaster. Example: {
"purpose": "preview",
"size": "medium",
"variant": "xyz"
}

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
body = veritone_dmh.CreateRenditionRequest() # CreateRenditionRequest |  (optional)

try:
    # Create a rendition for a clip
    api_response = api_instance.create_rendition_for_clip(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->create_rendition_for_clip: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
body	CreateRenditionRequest		[optional]

Return type

Response

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]

create_rendition_for_clip_by_core

Response create_rendition_for_clip_by_core(id, body=body)

Create a rendition for a clip

Required Permissions: CreateClipRendition Developer Information: The request must contain valid size, purpose and uri. IMPORTANT:The valid size are: full, xlarge, large, medium, small. The valid purpose are: comp, preview, thumbnail, housemaster. The uri cannot be null. Example: {
"purpose": "preview",
"size": "medium",
"variant": "xyz",
"uri": "uri"
}

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
body = veritone_dmh.CreateRenditionByCore() # CreateRenditionByCore |  (optional)

try:
    # Create a rendition for a clip
    api_response = api_instance.create_rendition_for_clip_by_core(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->create_rendition_for_clip_by_core: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
body	CreateRenditionByCore		[optional]

Return type

Response

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]

delete_rendition_for_clip

Response delete_rendition_for_clip(id, rendition_id, delete_file=delete_file)

Delete a rendition for a clip

Required Permissions: DeleteClipRendition Developer Information: The request delete the rendition from the rendition table in the database and/or delete the rendition file from S3 bucket. Example: deleteFile is false then delete the rendition from the rendition table in the database only,
keep the rendition file.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
rendition_id = 789 # int | Rendition Id
delete_file = false # bool | Delete the rendition file from the S4 bucket. (optional) (default to false)

try:
    # Delete a rendition for a clip
    api_response = api_instance.delete_rendition_for_clip(id, rendition_id, delete_file=delete_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->delete_rendition_for_clip: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
rendition_id	int	Rendition Id
delete_file	bool	Delete the rendition file from the S4 bucket.	[optional] [default to false]

Return type

Response

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_edit_detail

AssetEditField get_asset_edit_detail(field_name=field_name)

Retrieve the field definition for the specified field.

Required Permissions: ViewFieldDefinitions Developer Information: Returns the field definition for the specified field.

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.ClipApi(veritone_dmh.ApiClient(configuration))
field_name = 'field_name_example' # str | Name of field to retrieve (optional)

try:
    # Retrieve the field definition for the specified field.
    api_response = api_instance.get_asset_edit_detail(field_name=field_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->get_asset_edit_detail: %s\n" % e)

Parameters

Name	Type	Description	Notes
field_name	str	Name of field to retrieve	[optional]

Return type

AssetEditField

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]

invalidate_cache

invalidate_cache(body=body)

Invalidate caches in the app.

Required Permissions: InvalidateCache 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.ClipApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.CacheInvalidateParams() # CacheInvalidateParams |  (optional)

try:
    # Invalidate caches in the app.
    api_instance.invalidate_cache(body=body)
except ApiException as e:
    print("Exception when calling ClipApi->invalidate_cache: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	CacheInvalidateParams		[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]

remove_clips_from_content_owners_inventory

Response remove_clips_from_content_owners_inventory(body=body)

Remove clips from content owner's inventory

Required Permissions: RemoveClips 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.ClipApi(veritone_dmh.ApiClient(configuration))
body = veritone_dmh.ClipIdsRequest() # ClipIdsRequest |  (optional)

try:
    # Remove clips from content owner's inventory
    api_response = api_instance.remove_clips_from_content_owners_inventory(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->remove_clips_from_content_owners_inventory: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ClipIdsRequest		[optional]

Return type

Response

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]

watermark

Response watermark(id, body=body)

Retrieve watermarked rendition of specified clip.

Required Permissions: CreateDynamicOverlay Developer Information: Returns a watermarked image if rendition type is marked as imageOverlaySource.

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.ClipApi(veritone_dmh.ApiClient(configuration))
id = 789 # int | Clip Id
body = veritone_dmh.Configuration() # Configuration | Specifications for watermarking (optional)

try:
    # Retrieve watermarked rendition of specified clip.
    api_response = api_instance.watermark(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClipApi->watermark: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Clip Id
body	Configuration	Specifications for watermarking	[optional]

Return type

Response

Authorization

ApiKeyQuery

HTTP request headers

• Content-Type: application/json
• Accept: image/gif, image/jpeg, image/png

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