2022-09-09 changelog

Miro REST API: Document, image, and embed items: We’ve added a new parameter that contains the URL to download the resource.

What has changed

Document items

We’ve added the documentUrl parameter in the response. The documentUrl parameter contains the URL to download the resource. You must use your access token to access the URL. The URL contains the redirect parameter to control the request execution.



redirectparameter: 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 is application/octet-stream.

For more information, see the Document item REST API reference.

Image items

We’ve added the imageUrl parameter in the response. The imageUrl parameter contains the 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 parameter: 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.

For more information, see the Image item REST API reference.

Embed items

We’ve added the previewUrl parameter in the response. The previewUrl parameter contains the 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 parameter: 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.

For more information, see the Embed item REST API reference.