Aviaryconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 34 actions for the Aviaryconnector v1.0.

Authorization

POST Authorization: /api/v1/auth/sign_in

/api/v1/auth/sign_in

This endpoint allows Aviary users to sign in with an API Key and, upon successful authentication, returns a JSON response containing data about the user's profile and data about each of the organizations that the user is a member of. For more information about generating an Aviary user API Key, see: Creating an API Key.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Collections (5)

GET /api/v1/collections

/api/v1/collections

Retrieve a list of all collections.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

POST /api/v1/collections

/api/v1/collections

Create a new collection.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (30)

Option Name	Description
`Title`	string \| required
`About`	string \| optional
`Image`	file \| optional
`Is Public`	boolean \| optional [true, false]
`Is Featured`	boolean \| optional [true, false]
`Favicon`	file \| optional
`Click Through`	boolean \| optional [true, false]
`Conditions For Access`	string \| optional
`Automated Access Approval`	boolean \| optional [true, false]
`Period Of Access`	string \| optional [Ongoing, Fixed, Duration]
`Time Period`	string \| optional
`Target Of Access`	stext \| optional [resource, collection]
`Access Request Approval Email`	string \| optional
`Display Banner`	boolean \| optional [true, false]
`Global Ip Enabled`	boolean \| optional [true, false]
`From Name`	string \| optional
`Subject`	string \| optional
`Bcc Request Email`	string \| optional
`Is Audio Only`	boolean \| optional [true, false]
`Disable Player`	boolean \| optional [true, false]
`Banner Slider Resources`	string \| optional
`Banner Type`	string \| optional [banner_image, featured_resources_slider]
`Default Tab Selection`	string \| optional [resources, about]
`Enable Resource Search`	boolean \| optional [true, false]
`Search Resource Placeholder`	string \| optional
`Enable Itc Autoscroll`	boolean \| optional [true, false]
`Card Image`	file \| optional
`Enable Alternative Playback`	boolean \| optional [true, false]
`Default Thumb`	file \| optional
`Enable Default Thumb`	boolean \| optional [true, false]

PUT /api/v1/collections/{collection_id}

/api/v1/collections/{collection_id}

Update an existing collection identified by its ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Collection Id`	collection_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (30)

Option Name	Description
`Title`	string \| required
`About`	string \| optional
`Image`	file \| optional
`Is Public`	boolean \| optional [true, false]
`Is Featured`	boolean \| optional [true, false]
`Favicon`	file \| optional
`Click Through`	boolean \| optional [true, false]
`Conditions For Access`	string \| optional
`Automated Access Approval`	boolean \| optional [true, false]
`Period Of Access`	string \| optional [Ongoing, Fixed, Duration]
`Time Period`	string \| optional
`Target Of Access`	stext \| optional [resource, collection]
`Access Request Approval Email`	string \| optional
`Display Banner`	boolean \| optional [true, false]
`Global Ip Enabled`	boolean \| optional [true, false]
`From Name`	string \| optional
`Subject`	string \| optional
`Bcc Request Email`	string \| optional
`Is Audio Only`	boolean \| optional [true, false]
`Disable Player`	boolean \| optional [true, false]
`Banner Slider Resources`	string \| optional
`Banner Type`	string \| optional [banner_image, featured_resources_slider]
`Default Tab Selection`	string \| optional [resources, about]
`Enable Resource Search`	boolean \| optional [true, false]
`Search Resource Placeholder`	string \| optional
`Enable Itc Autoscroll`	boolean \| optional [true, false]
`Card Image`	file \| optional
`Enable Alternative Playback`	boolean \| optional [true, false]
`Default Thumb`	file \| optional
`Enable Default Thumb`	boolean \| optional [true, false]

GET /api/v1/collections/{collection_id}/metadata

/api/v1/collections/{collection_id}/metadata

Retrieve the metadata for a specific collection.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Collection Id`	collection_id
`Response Type`	The response format expected from the API (e.g. application/json).

GET /api/v1/collections/{collection_id}/resources

/api/v1/collections/{collection_id}/resources

Retrieve the list of resources within a specific collection.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	ID of your organization
`Page Number`	Starts with 1
`Page Size`	Max limit is 100
`Collection Id`	ID of your collection
`Response Type`	The response format expected from the API (e.g. application/json).

Imports (3)

GET /api/v1/imports

/api/v1/imports

Retrieve a list of all imports.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

POST /api/v1/imports

/api/v1/imports

Create a new import job.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (10)

Option Name	Description
`Collection Id`	Identifier of the collection to import into.
`Import Type`	Numeric code indicating the type of import.
`Status`	Numeric code representing the desired status of the import.
`New Collection Name`	Name for a new collection if one should be created.
`Resource File`	Path or identifier of the resource file to import.
`Media File`	Path or identifier of the media file to import.
`Transcript File`	Path or identifier of the transcript file to import.
`Index File`	Path or identifier of the index file to import.
`Zip File`	Path or identifier of a ZIP file containing import data.
`Title`	Title for the import job.

GET /api/v1/imports/{id}

/api/v1/imports/{id}

Retrieve details of a specific import by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	collection_id
`Response Type`	The response format expected from the API (e.g. application/json).

Indexes (4)

POST /api/v1/indexes

/api/v1/indexes

Create a new index.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Language`	Language code for the index (e.g., 'en').
`Title`	Title of the index.
`Is Public`	Whether the index should be publicly accessible.
`Associated File`	Path or identifier of a file to associate with the index.
`Resource File Id`	Media ID
`Is Aes60 Xml`	Whether the index uses the AES60 XML format.
`Remove Title`	Whether to remove the title from the index content.
`Description`	Description of the index.
`Metadata`	Array of metadata entries for the index.

DELETE /api/v1/indexes/{id}

/api/v1/indexes/{id}

Permanently delete a specific index by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	index_id
`Response Type`	The response format expected from the API (e.g. application/json).

GET /api/v1/indexes/{id}

/api/v1/indexes/{id}

Retrieve details of a specific index by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	index_id
`Response Type`	The response format expected from the API (e.g. application/json).

PUT /api/v1/indexes/{id}

/api/v1/indexes/{id}

Update an existing index identified by its ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	index_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Language`	New language code for the index.
`Is Public`	Whether the index should be publicly accessible.
`Description`	New description for the index.
`Title`	New title for the index.
`Is Aes60 Xml`	Whether the index uses the AES60 XML format.

Media (Importing via pre-signed URL) (3)

GET Update the status of media file as complete after successfully uploading to wasabi presigned url.

/api/v1/media_files/{id}/complete

Update the status of media file as complete after successfully uploading to wasabi presigned url.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload a new media file for a resource

/api/v1/media_files

Upload a new media file for a resource using a pre-signed URL.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	ID of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Collection Resource Id`	Identifier of the collection resource to attach the media file to.
`Access`	Whether the media file should be accessible.
`Is 360`	Whether the media is a 360-degree video.
`Is Downloadable`	Whether the media file can be downloaded by viewers.
`Turn On Cc`	Whether to enable closed captions for the media.
`Media File`	Path or identifier of the media file to upload.
`Media File Link`	URL link to the media file if not uploading directly.
`Media Embed Code`	Embed code for the media from an external source.
`Media Embed Type`	Type of embed code (e.g., 'iframe').
`Title`	Title for the media file.
`Duration`	Duration of the media in seconds.
`Target Domain`	Domain that is allowed to embed or access the media.
`Display Name`	Display name for the media file.
`Filename`	Original filename of the media file.
`Metadata[description][][value]`	Value for a metadata entry with the key 'description'.
`Metadata[description][][vocabulary]`	Vocabulary for a metadata entry with the key 'description'.
`Metadata[publisher][][value]`	Value for a metadata entry with the key 'publisher'.

PUT https://aviary-odin-weareavp.s3.wasabisys.com/collection_resource_files/resource_files/000/000/335/original/1668480870_PS549C3S62004vx_AM_01_01.mp4

https://aviary-odin-weareavp.s3.wasabisys.com/collection_resource_files/resource_files/000/000/335/original/1668480870_PS549C3S62004vx_AM_01_01.mp4

Upload a media file to a pre-signed URL provided by Aviary. Use this action to import media by directly uploading to the storage location.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`X-amz-algorithm`	The signing algorithm used for the AWS Signature Version 4 request.
`X-amz-credential`	The access key and scope that identify the signer.
`X-amz-date`	The date and time used to create the signature, in ISO 8601 format.
`X-amz-expires`	The time in seconds until the pre-signed URL expires.
`X-amz-signedheaders`	The list of HTTP headers included in the signature.
`X-amz-signature`	The cryptographic signature that authenticates the request.

Media Files (6)

GET /api/v1/media_files/{id}

/api/v1/media_files/{id}

Retrieve the details of a specific media file by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

PUT /api/v1/media_files/{id}

/api/v1/media_files/{id}

Update the properties of a specific media file by its ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Collection Resource Id`	Identifier of the collection resource to attach the media file to.
`Access`	Whether the media file should be accessible.
`Is 360`	Whether the media is a 360-degree video.
`Is Downloadable`	Whether the media file can be downloaded by viewers.
`Turn On Cc`	Whether to enable closed captions for the media.
`Media File`	Path or identifier of the media file to upload.
`Media File Link`	URL link to the media file if not uploading directly.
`Media Embed Code`	Embed code for the media from an external source.
`Media Embed Type`	Type of embed code (e.g., 'iframe').
`Title`	Title for the media file.
`Duration`	Duration of the media in seconds.
`Target Domain`	Domain that is allowed to embed or access the media.
`Display Name`	Display name for the media file.
`Filename`	Original filename of the media file.
`Metadata[description][][value]`	Value for a metadata entry with the key 'description'.
`Metadata[description][][vocabulary]`	Vocabulary for a metadata entry with the key 'description'.
`Metadata[publisher][][value]`	Value for a metadata entry with the key 'publisher'.

DELETE Delete media file from your organization resource.

/api/v1/media_files/{id}

Delete media file from your organization resource.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

PUT This will update the media thumbnail.

/api/v1/media_files/{id}/thumbnail

This will update the media thumbnail.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Thumbnail Image`	The base64-encoded image data or URL for the new thumbnail.

POST Upload a new media file for a resource

/api/v1/media_files/{id}

The Aviary API does not allow media files larger than 100 MB to be directly uploaded. Instead, users must break media files into 100 MB chunks and send each piece describing it and the content range in the POST to the chunked media file upload endpoint (a slightly different workflow from single file upload).

Here we have a example:

import requests
import os
import uuid
from uuid import uuid4
CHUNK_SIZE = 1000000

def read_in_chunks(file_object, CHUNK_SIZE):
    while True:
        data = file_object.read(CHUNK_SIZE)
        if not data:
            break
        yield data


def upload(file, url):
  content_name = str(file)
  content_path = os.path.abspath(file)
  content_size = os.stat(content_path).st_size


print(content_name, content_path, content_size)


f = open(content_path, “rb”)


index = 0
  offset = 0
  headers = {}


for chunk in read_in_chunks(f, CHUNK_SIZE):
    offset = index + len(chunk)
    headers[‘Content-Range’] = ‘bytes %s-%s/%s’ % (index, offset -1, content_size)
    headers[‘access-token’] = ‘ErutfY1xgh2aLfT8OG-qcA’
    headers[‘client’] = ‘T1JsOijMdkKMPlIjf-fGmQ’
    headers[‘uid’] = ‘user@example.com’
    headers[‘organization-id’] = ‘5’
    index = offset
    try:
        params = {“collection_resource_id”: “90”,“access”: “true”,“filename”: “sample.mp4”,“is_360”: “false”, “title”: str(uuid4())}
        files = {“media_file”: chunk}
        r = requests.post(url=url, files=files,params=params, headers=headers)
        print(r.json())
        print(“r: %s, Content-Range: %s” % (r, headers[‘Content-Range’]))
    except Exception as e:
        print(e)
upload(‘Video1.mp4’, “https://aviaryplatform.com/api/v1/media_files”)

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Collection Resource Id`	Identifier of the collection resource to attach the media file to.
`Access`	Whether the media file should be accessible.
`Is 360`	Whether the media is a 360-degree video.
`Is Downloadable`	Whether the media file can be downloaded by viewers.
`Turn On Cc`	Whether to enable closed captions for the media.
`Media File`	Path or identifier of the media file to upload.
`Media File Link`	URL link to the media file if not uploading directly.
`Media Embed Code`	Embed code for the media from an external source.
`Media Embed Type`	Type of embed code (e.g., 'iframe').
`Title`	Title for the media file.
`Duration`	Duration of the media in seconds.
`Target Domain`	Domain that is allowed to embed or access the media.
`Display Name`	Display name for the media file.
`Filename`	Original filename of the media file.
`Metadata[description][][value]`	Value for a metadata entry with the key 'description'.
`Metadata[description][][vocabulary]`	Vocabulary for a metadata entry with the key 'description'.
`Metadata[publisher][][value]`	Value for a metadata entry with the key 'publisher'.

DELETE this will delete the media thumbnail and place a default aviary thumbnail.

/api/v1/media_files/{id}/thumbnail

this will delete the media thumbnail and place a default aviary thumbnail.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	media_file_id
`Response Type`	The response format expected from the API (e.g. application/json).

Resources (4)

GET Use GET request to fetch resource data using an existing custom unique identifier. Convert the durations value into hours, minutes, and seconds. total_seconds = 11289.30776 Convert to hours, minutes, seconds hours = int(total_seconds / 3600) minutes = int((total_seconds % 3600) / 60) seconds = int(total_seconds % 60) Format as hh:mm:ss time_formatted = f"{hours:02}:{minutes:02}:{seconds:02}"

/api/v1/resources/{custom_unique_identifier}

Use GET request to fetch resource data using an existing custom unique identifier.

Convert the durations value into hours, minutes, and seconds.

total_seconds = 11289.30776

Convert to hours, minutes, seconds

hours = int(total_seconds / 3600)

minutes = int((total_seconds % 3600) / 60)

seconds = int(total_seconds % 60)

Format as hh:mm:ss

time_formatted = f"{hours:02}:{minutes:02}:{seconds:02}"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Custom Unique Identifier`	custom unique identifier
`Response Type`	The response format expected from the API (e.g. application/json).

GET Use GET request to fetch resource data using an existing resource id. Convert the durations value into hours, minutes, and seconds. total_seconds = 11289.30776 Convert to hours, minutes, seconds hours = int(total_seconds / 3600) minutes = int((total_seconds % 3600) / 60) seconds = int(total_seconds % 60) Format as hh:mm:ss time_formatted = f"{hours:02}:{minutes:02}:{seconds:02}"

/api/v1/resources/{resource_id}

Use GET request to fetch resource data using an existing resource id.

Convert the durations value into hours, minutes, and seconds.

total_seconds = 11289.30776

Convert to hours, minutes, seconds

hours = int(total_seconds / 3600)

minutes = int((total_seconds % 3600) / 60)

seconds = int(total_seconds % 60)

Format as hh:mm:ss

time_formatted = f"{hours:02}:{minutes:02}:{seconds:02}"

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Resource Id`	resource_id
`Response Type`	The response format expected from the API (e.g. application/json).

POST Use POST to create a new resource in an existing collection (a collection must be created first).

/api/v1/resources

Use POST to create a new resource in an existing collection (a collection must be created first).

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (29)

Option Name	Description
`Collection Id`	Identifier of the collection to import into.
`Title`	Title for the media file.
`Access`	Specify the access level for the resource.
`Is Featured`	Indicate whether the resource is featured.
`Custom Unique Identifier`	Provide a custom unique identifier for the resource.
`Metadata[preferred citation][][value]`	Provide the value for the 'Preferred Citation' metadata field.
`Metadata[source metadata uri][][value]`	Provide the value for the 'Source Metadata URI' metadata field.
`Metadata[publisher][][value]`	Provide the value for the 'Publisher' metadata field.
`Metadata[rights statement][][value]`	Provide the value for the 'Rights Statement' metadata field.
`Metadata[source][][value]`	Provide the value for the 'Source' metadata field.
`Metadata[agent][][value]`	Provide the value for the 'Agent' metadata field.
`Metadata[agent][][vocabulary]`	Specify the vocabulary for the 'Agent' metadata field.
`Metadata[date][][value]`	Provide the value for the 'Date' metadata field.
`Metadata[date][][vocabulary]`	Specify the vocabulary for the 'Date' metadata field.
`Metadata[coverage][][value]`	Provide the value for the 'Coverage' metadata field.
`Metadata[coverage][][vocabulary]`	Specify the vocabulary for the 'Coverage' metadata field.
`Metadata[language][][value]`	Provide the value for the 'Language' metadata field.
`Metadata[language][][vocabulary]`	Specify the vocabulary for the 'Language' metadata field.
`Metadata[description][][value]`	Provide the value for the 'Description' metadata field.
`Metadata[description][][vocabulary]`	Specify the vocabulary for the 'Description' metadata field.
`Metadata[format][][value]`	Provide the value for the 'Format' metadata field.
`Metadata[identifier][][value]`	Provide the value for the 'Identifier' metadata field.
`Metadata[identifier][][vocabulary]`	Specify the vocabulary for the 'Identifier' metadata field.
`Metadata[relation][][value]`	Provide the value for the 'Relation' metadata field.
`Metadata[relation][][vocabulary]`	Specify the vocabulary for the 'Relation' metadata field.
`Metadata[subject][][value]`	Provide the value for the 'Subject' metadata field.
`Metadata[subject][][vocabulary]`	Specify the vocabulary for the 'Subject' metadata field.
`Metadata[keyword][][value]`	Provide the value for the 'Keyword' metadata field.
`Metadata[type][][value]`	Provide the value for the 'Type' metadata field.

PUT Use PUT request to update an existing resource.

/api/v1/resources/{id}

Use PUT request to update an existing resource.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Title`	Title for the media file.
`Access`	Set the new access level for the resource.
`Is Featured`	Indicate whether the resource should be featured.

Supplemental Files (4)

POST /api/v1/supplemental_files

/api/v1/supplemental_files

Upload a new supplemental file to the system.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Title`	Title for the media file.
`Access`	Whether the media file should be accessible.
`Description`	New description for the index.
`Collection Resource Id`	Resource ID
`Associated File`	Path or identifier of a file to associate with the index.

DELETE /api/v1/supplemental_files/{id}

/api/v1/supplemental_files/{id}

Permanently delete a supplemental file by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	supplemental_id
`Response Type`	The response format expected from the API (e.g. application/json).

GET /api/v1/supplemental_files/{id}

/api/v1/supplemental_files/{id}

Retrieve details of a specific supplemental file by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	supplemental_id
`Response Type`	The response format expected from the API (e.g. application/json).

PUT /api/v1/supplemental_files/{id}

/api/v1/supplemental_files/{id}

Update an existing supplemental file by its ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	supplemental_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Title`	Title for the media file.
`Access`	Whether the media file should be accessible.
`Description`	New description for the index.
`Collection Resource Id`	Identifier of the collection resource to attach the media file to.
`Associated File`	Path or identifier of a file to associate with the index.

Transcripts (4)

POST /api/v1/transcripts

/api/v1/transcripts

Create a new transcript for a resource.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Is Caption`	Specify whether the transcript is a caption.
`Language`	New language code for the index.
`Title`	Title for the media file.
`Is Public`	Whether the index should be publicly accessible.
`Associated File`	Path or identifier of a file to associate with the index.
`Resource File Id`	Media ID
`Remove Title`	Whether to remove the title from the index content.
`Description`	New description for the index.
`Is Downloadable`	Indicate if the transcript is downloadable.

GET /api/v1/transcripts/{id}

/api/v1/transcripts/{id}

Retrieve details of a specific transcript by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Id`	transcript_id
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE /api/v1/transcripts/{transcript_id}

/api/v1/transcripts/{transcript_id}

Permanently delete a transcript by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Transcript Id`	transcript_id
`Response Type`	The response format expected from the API (e.g. application/json).

PUT /api/v1/transcripts/{transcript_id}

/api/v1/transcripts/{transcript_id}

Update an existing transcript with the specified resource file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Organization-id`	Id of your organization
`Transcript Id`	transcript_id
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Is Caption`	Specify whether the transcript is a caption.
`Resource File Id`	The ID of the resource file to associate with the transcript.
`Description`	New description for the index.
`Is Downloadable`	Indicate if the transcript is downloadable.