.. index:: Advertisement, Image

.. _image:

Image
=====

An image.

Fields
------

.. apifields::
    .. apifield::
        :name: mediaId
        :type: string
        :constraints: --
        :required: true
        :updateable: false
        :writable: false

        Unique identifier of this image

    .. apifield::
        :name: imageId
        :type: int
        :constraints: --
        :required: true
        :updateable: false
        :writable: false

        (deprecated) Unique identifier of this image. Superseded by mediaId

    .. apifield::
        :name: status
        :type: string
        :constraints: one of ``available``, ``downloading``
        :required: true
        :updateable: false
        :writable: false

        One of downloading or available.

Relations
---------

.. relations::
    .. relation::
        :name: mp:image-blob
    .. relation::
        :name: mp:image-meta

Reference
---------

.. endpoint:: GET /v1/images/{mediaId}

Examples
--------

.. include:: examples/get-image-example.rst