Optional
contentType of the embedded item's content.
Optional
descriptionShort description of the embedded item.
Optional
htmlHtml code of the embedded item.
Optional
modeDefines how the content in the embed item is displayed on the board. inline
: The embedded content is displayed directly on the board. modal
: The embedded content is displayed inside a modal overlay on the board.
Optional
previewThe URL to download the resource. You must use your access token to access the URL. The URL contains the redirect
parameter and the format
parameter to control the request execution as described in the following parameters: format
parameter: By default, the image format is set to the preview image. If you want to download the original image, set the format
parameter in the URL to original
. redirect
: By default, the redirect
parameter is set to false
and the resource object containing the URL and the resource type is returned with a 200 OK HTTP code. This URL is valid for 60 seconds. You can use this URL to retrieve the resource file. If the redirect
parameter is set to true
, a 307 TEMPORARY_REDIRECT HTTP response is returned. If you follow HTTP 3xx responses as redirects, you will automatically be redirected to the resource file and the content type returned can be image/png
, 'image/svg', or 'image/jpg', depending on the original image type.
Optional
providerName of the content's provider.
Optional
providerUrl of the content's provider.
Optional
titleTitle of the embedded item.
Optional
urlA valid URL pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS.
Miro Developer Platform <img src="https://content.pstmn.io/47449ea6-0ef7-4af2-bac1-e58a70e61c58/aW1hZ2UucG5n\" width="1685" height="593"> ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? Read our introduction page and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - Quickstart (video): try the REST API in less than 3 minutes. - Quickstart (article): get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - Get started with OAuth 2.0 and Miro ### Miro App Examples Clone our Miro App Examples repository to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0.
The version of the OpenAPI document: v2.0
NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech Do not edit the class manually.