Multimedia Properties
This document describes all the properties available in the multimedia object. These properties are used across all multimedia endpoints for creating, retrieving, updating, and filtering multimedia content.
| Property | Type | Required | ReadOnly | Description |
|---|---|---|---|---|
| id | string | No | Yes | Multimedia ID |
| organizationId | string | No | Yes | Organization ID |
| createAt | date | No | Yes | Multimedia date of creation |
| updatedAt | date | No | Yes | Multimedia last update date |
| name | string | Yes | No | Multimedia name |
| app | App | No | No | App information for multimedia of type application/immersive |
| url | string | Yes | No | Multimedia URL, in the case of application/immersive is the cover image |
| format | string | Yes | No | Multimedia format. For Example: - application/immersive - image/jpeg - video/mp4 |
| description | string | No | No | Multimedia description |
| size | number | For multimedia of types image/* and video/* | No | Multimedia size |
| duration | number | For multimedia of type video/* | No | Multimedia duration |
| status | string | No | Yes | Multimedia status. Possible values: - ready - need_action - error |
| environment | object | No | No | Environment vars for multimedia of type application/immersive, is a plain object with the following structure { [key: string]: string | number } |
| coverVideo | CoverVideo | No | No | Video to use as cover for multimedia of type application/immersive |
| options | Options | No | No | General options |