Objects Assets | Moovly Online Video Maker
- Intro
- 1. Authentication
- 2. Libraries Libraries overview
- API schema (Get libraries)
- Example Response
- Library creation
- API schema (Create a library)
- 3. Assets Assets overview
- API schema (Get your assets from your library)
- Example response
- Asset management
- API schema (Add an object)
- 4. Text to speech (tts) voices
Intro
Libraries, objects and assets are closely related entities in Moovly. When an asset is uploaded, we transform it into different resolutions so we can select the most appropriate asset depending on the situation. To keep track of these (transformed) assets, we create a parent Object for them. Those assets/objects are then grouped into libraries. Libraries can be personal to a specific user or group, but also public libraries and stock libraries are supported.
There are many objects in the Moovly platform and currently three of them are supported in the public API:
- Audio
- Images
- Video
As a general rule, there are no hard file limits as of this moment. Most common file types are supported and an up to date list can be found here.
1. Authentication
All API calls need to be authenticated with an access token. To generate an access token, head to our Developer Portal and use the token as a bearer token in the Authentication header of each API call.
2. Libraries
Libraries overview
When you want a list of which objects are in which library, you’ll first need to know the id of your library. The following API call allows you to get an overview of each of you libraries, including their type and id.
Get libraries
Get users libraries
Response 200 (successful operation)
Type: Array
group_name
string
Name of the libraries group
type
Type of the library group
libraries
array
Libraries in this group
Detail of a Library
name
searchable
boolean
external
has_categories
base_url
locked
editable
thumbnail
supported_object_types
default_type
predefined_searches"
sort_order
integer
premium
scope
shares
Example Response
Library creation
Whenever a more organised structure for you assets is required, you can create new libraries to categorise them. This is done through a POST call to the library endpoint and supplying the name parameter as form data.
Create a library
Create a new library
Request body (application/x-www-form-urlencoded)
The name of the library
Id of the library
Name of the library
label
query
children
order
has_business_label
guid
3. Assets
Assets overview
To get a list of all assets in a specific library, you need to have the id of your library.
Get your assets from your library
Get your assets from your library
Input parameters
limit
Amount of assets to be returned
page
Page number of the assets; starts counting at 1
assets
Example response
Note that the assets.metatdata.id is the id that is required in the automator when you want to use your assets for automated video creation.
Asset management
To add an asset to one of your libraries, you need to know the library id and pick a file name for your asset. Those required properties library_id and filename are to be provided as form data.
Add an object
Add an object
filename
Name of the file
library_id
url
Url on s3 where you need to upload the file to
data
object
Asset of a library
upload_id
created_at
library_object_id
status
metadata
As a response you’ll receive a singed AWS S3 url to upload your asset to.
Add the file as binary data in the body of a PUT call to that S3 url. Upon receiving your asset we’ll add it to the library specified in the previous call.
4. Text to speech (tts)
Explanation about text to speech
voices
We support multiple providers with voices. You can find below all supported voices.
You can use these voices in by example the api call for creating video’s from a template
The identifier you can copy from the template below