| Fields | Description |
|---|---|
format | Data format SRT only is supported, if you have an other format please convert it to SRT. |
id | Unique object identifier (unique among all subtitles) |
item_type | Graph type of this object (hopefully subtitle) |
language | Language of these subtitles. |
language_label | Subtitles’s language in its own language. |
url | GET - URL pointing to the latest subtitle version / POST - URL pointing to the subtitle you would like to upload. |
Default values
These fields are returned by default in the API answer when you do not specify specific fields in your API calls:
- id
- language
format
formatData format SRT only is supported, if you have an other format please convert it to SRT.
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | srt | Public | N/A |
id
idUnique object identifier (unique among all subtitles)
| Type | Sample value | Read access | Write access |
|---|---|---|---|
| string | xqf5vs9 | Public | N/A |
item_type
item_typeGraph type of this object (hopefully subtitle).
minimum lenght: 1 character / max lenght: 150 characters
| Type | Sample value | Read access (scope) | Write access (scope) |
|---|---|---|---|
| date | subtitle | Public | N/A |
language
languageLanguage of these subtitles.
minimum lenght: 1 character / max lenght: 150 characters
| Type | Sample value | Read access (scope) | Write access (scope) |
|---|---|---|---|
| string | en | Public | Private, can be written by the owner of the object |
language_label
language_labelSubtitles’s language in its own language.
minimum lenght: 1 character / max lenght: 150 characters
| Type | Sample value | Read access (scope) | Write access (scope) |
|---|---|---|---|
| string | Français | Public | N/A |
url
urlWhen using GET method, the URL pointing to the latest version of the subtitles.
When using POST method, the URL field must point to the subtitle data in on of the valid formats.
Subtitle upload
You don’t need to host the file, you can use the
GET /file/uploadAPI ressource to create a temporary URL to a file of your own, just like when you upload a video source file.If you host your own file, the file will be fetched and the subtitles URL will point to a local copy.
| Type | Sample value | Read access (scope) | Write access (scope) |
|---|---|---|---|
| url | https://static2.dmcdn.net[...]:subtitle_en.srt?22 | Public | Private, can be written by the owner of the object |