Media

Other Resources · 6 endpoints

GET/v1/media

List Media

app_install_bearerscope: media:read

Parameters

Field	Type	Required	Description
`folder`query	`string`	optional	general, categories, services, addons, products, editor, website, branding, forms, vendors
`usage_context`query	`string`	optional	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`media_type`query	`string`	optional	image, document, video
`limit`query	`integer`	optional
`starting_after`query	`string`	optional
`ending_before`query	`string`	optional

Returns · 200

Field	Type	Required	Description
`data`	`MediaListResponse`	required
`data.has_more`	`boolean`	required
`data.items`	`MediaObject[]`	required
`data.items[].alt_text`	`string`	optional
`data.items[].bytes`	`integer`	optional
`data.items[].caption`	`string`	optional
`data.items[].created_at`	`string`	optional
`data.items[].dimensions`	`MediaDimensions`	optional
`data.items[].filename`	`string`	optional
`data.items[].folder`	`string`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.items[].id`	`string`	required
`data.items[].media_type`	`string`	optional	image, document, video
`data.items[].mime_type`	`string`	optional
`data.items[].object`	`string`	optional	media
`data.items[].title`	`string`	optional
`data.items[].updated_at`	`string`	optional
`data.items[].url`	`string`	required
`data.items[].usage_context`	`string`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.items[].variants`	`object`	optional
`data.next_cursor`	`string`	optional
`data.object`	`string`	optional	list
`data.url`	`string`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media \
  -H "Authorization: Bearer $GETME_API_KEY"

POST/v1/media

Upload Media

app_install_bearerscope: media:writeidempotent

Parameters

Field	Type	Required	Description
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · multipart/form-data

Field	Type	Required	Description
`alt_text`	`string`	optional
`file`	`file`format: binary	required
`folder`	`string`	optional	general, categories, services, addons, products, editor, website, branding, forms, vendors
`title`	`string`	optional
`usage_context`	`string`	optional	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

Returns · 200

Field	Type	Required	Description
`data`	`MediaObject`	required
`data.alt_text`	`string`	optional
`data.bytes`	`integer`	optional
`data.caption`	`string`	optional
`data.created_at`	`string`	optional
`data.dimensions`	`MediaDimensions`	optional
`data.dimensions.height`	`integer`	optional
`data.dimensions.width`	`integer`	optional
`data.filename`	`string`	optional
`data.folder`	`string`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.id`	`string`	required
`data.media_type`	`string`	optional	image, document, video
`data.mime_type`	`string`	optional
`data.object`	`string`	optional	media
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`data.url`	`string`	required
`data.usage_context`	`string`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.variants`	`object`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -F "alt_text=alt text" \
  -F "file=@./hero.png" \
  -F "folder=general" \
  -F "title=title" \
  -F "usage_context=category"

GET/v1/media/catalog

Media Catalog

app_install_bearerscope: media:read

Returns · 200

Field	Type	Required	Description
`data`	`MediaCatalogResponse`	required
`data.allowed_extensions`	`string[]`	required	.jpg, .jpeg, .png, .gif, .webp, .ico, .pdf, .mp4, .webm
`data.allowed_mime_types`	`string[]`	required	image/jpeg, image/png, image/gif, image/webp, image/x-icon, image/vnd.microsoft.icon, application/pdf, video/mp4, video/webm
`data.asset_families`	`object`	required
`data.folders`	`string[]`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.max_bytes`	`integer`	required
`data.media_types`	`string[]`	required	image, document, video
`data.object`	`string`	optional	media_catalog
`data.private_media`	`object`	required
`data.usage_contexts`	`string[]`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.visibility`	`string`	optional	public
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media/catalog \
  -H "Authorization: Bearer $GETME_API_KEY"

GET/v1/media/{media_id}

Get Media

app_install_bearerscope: media:read

Parameters

Field	Type	Required	Description
`media_id`path	`string`	required	Public media identifier, for example cmda_1234567890ABCDEFGHijk.

Returns · 200

Field	Type	Required	Description
`data`	`MediaObject`	required
`data.alt_text`	`string`	optional
`data.bytes`	`integer`	optional
`data.caption`	`string`	optional
`data.created_at`	`string`	optional
`data.dimensions`	`MediaDimensions`	optional
`data.dimensions.height`	`integer`	optional
`data.dimensions.width`	`integer`	optional
`data.filename`	`string`	optional
`data.folder`	`string`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.id`	`string`	required
`data.media_type`	`string`	optional	image, document, video
`data.mime_type`	`string`	optional
`data.object`	`string`	optional	media
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`data.url`	`string`	required
`data.usage_context`	`string`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.variants`	`object`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media/{media_id} \
  -H "Authorization: Bearer $GETME_API_KEY"

PATCH/v1/media/{media_id}

Update Media

app_install_bearerscope: media:writeidempotent

Parameters

Field	Type	Required	Description
`media_id`path	`string`	required	Public media identifier, for example cmda_1234567890ABCDEFGHijk.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Request body · application/json

Field	Type	Required	Description
`alt_text`	`string`	optional
`caption`	`string`	optional
`folder`	`string`	optional	general, categories, services, addons, products, editor, website, branding, forms, vendors
`title`	`string`	optional
`usage_context`	`string`	optional	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

Returns · 200

Field	Type	Required	Description
`data`	`MediaObject`	required
`data.alt_text`	`string`	optional
`data.bytes`	`integer`	optional
`data.caption`	`string`	optional
`data.created_at`	`string`	optional
`data.dimensions`	`MediaDimensions`	optional
`data.dimensions.height`	`integer`	optional
`data.dimensions.width`	`integer`	optional
`data.filename`	`string`	optional
`data.folder`	`string`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.id`	`string`	required
`data.media_type`	`string`	optional	image, document, video
`data.mime_type`	`string`	optional
`data.object`	`string`	optional	media
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`data.url`	`string`	required
`data.usage_context`	`string`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.variants`	`object`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media/{media_id} \
  -X PATCH \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "alt_text": "alt_text",
    "caption": "caption",
    "folder": "general",
    "title": "title",
    "usage_context": "category"
  }'

POST/v1/media/{media_id}/archive

Archive Media

app_install_bearerscope: media:writeidempotent

Parameters

Field	Type	Required	Description
`media_id`path	`string`	required	Public media identifier, for example cmda_1234567890ABCDEFGHijk.
`Idempotency-Key`header	`string`	required	Unique key used to make this mutation retry-safe for the replay window.

Returns · 200

Field	Type	Required	Description
`data`	`MediaObject`	required
`data.alt_text`	`string`	optional
`data.bytes`	`integer`	optional
`data.caption`	`string`	optional
`data.created_at`	`string`	optional
`data.dimensions`	`MediaDimensions`	optional
`data.dimensions.height`	`integer`	optional
`data.dimensions.width`	`integer`	optional
`data.filename`	`string`	optional
`data.folder`	`string`	required	general, categories, services, addons, products, editor, website, branding, forms, vendors
`data.id`	`string`	required
`data.media_type`	`string`	optional	image, document, video
`data.mime_type`	`string`	optional
`data.object`	`string`	optional	media
`data.title`	`string`	optional
`data.updated_at`	`string`	optional
`data.url`	`string`	required
`data.usage_context`	`string`	required	category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor
`data.variants`	`object`	optional
`success`	`boolean`	required	true

Errors 400401403404409422429500

cURL

curl https://api.getmeonline.io/v1/media/{media_id}/archive \
  -X POST \
  -H "Authorization: Bearer $GETME_API_KEY" \
  -H "Idempotency-Key: idem_1234567890abcdef"

Field

Type

Required

Description

folderquery

string

optional

general, categories, services, addons, products, editor, website, branding, forms, vendors

usage_contextquery

string

optional

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

media_typequery

string

optional

image, document, video

limitquery

integer

optional

starting_afterquery

string

optional

ending_beforequery

string

optional

Field

Type

Required

Description

data

MediaListResponse

required

data.has_more

boolean

required

data.items

MediaObject[]

required

data.items[].alt_text

string

optional

data.items[].bytes

integer

optional

data.items[].caption

string

optional

data.items[].created_at

string

optional

data.items[].dimensions

MediaDimensions

optional

data.items[].filename

string

optional

data.items[].folder

string

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.items[].id

string

required

data.items[].media_type

string

optional

image, document, video

data.items[].mime_type

string

optional

data.items[].object

string

optional

media

data.items[].title

string

optional

data.items[].updated_at

string

optional

data.items[].url

string

required

data.items[].usage_context

string

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.items[].variants

object

optional

data.next_cursor

string

optional

data.object

string

optional

list

data.url

string

optional

success

boolean

required

true

Field

Type

Required

Description

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

alt_text

string

optional

file

fileformat: binary

required

folder

string

optional

general, categories, services, addons, products, editor, website, branding, forms, vendors

title

string

optional

usage_context

string

optional

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

Field

Type

Required

Description

data

MediaObject

required

data.alt_text

string

optional

data.bytes

integer

optional

data.caption

string

optional

data.created_at

string

optional

data.dimensions

MediaDimensions

optional

data.dimensions.height

integer

optional

data.dimensions.width

integer

optional

data.filename

string

optional

data.folder

string

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.id

string

required

data.media_type

string

optional

image, document, video

data.mime_type

string

optional

data.object

string

optional

media

data.title

string

optional

data.updated_at

string

optional

data.url

string

required

data.usage_context

string

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.variants

object

optional

success

boolean

required

true

curl https://api.getmeonline.io/v1/media \ -X POST \ -H "Authorization: Bearer $GETME_API_KEY" \ -H "Idempotency-Key: idem_1234567890abcdef" \ -F "alt_text=alt text" \ -F "file=@./hero.png" \ -F "folder=general" \ -F "title=title" \ -F "usage_context=category"

Field

Type

Required

Description

data

MediaCatalogResponse

required

data.allowed_extensions

string[]

required

.jpg, .jpeg, .png, .gif, .webp, .ico, .pdf, .mp4, .webm

data.allowed_mime_types

string[]

required

image/jpeg, image/png, image/gif, image/webp, image/x-icon, image/vnd.microsoft.icon, application/pdf, video/mp4, video/webm

data.asset_families

object

required

data.folders

string[]

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.max_bytes

integer

required

data.media_types

string[]

required

image, document, video

data.object

string

optional

media_catalog

data.private_media

object

required

data.usage_contexts

string[]

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.visibility

string

optional

public

success

boolean

required

true

Field

Type

Required

Description

media_idpath

string

required

Public media identifier, for example cmda_1234567890ABCDEFGHijk.

Field

Type

Required

Description

data

MediaObject

required

data.alt_text

string

optional

data.bytes

integer

optional

data.caption

string

optional

data.created_at

string

optional

data.dimensions

MediaDimensions

optional

data.dimensions.height

integer

optional

data.dimensions.width

integer

optional

data.filename

string

optional

data.folder

string

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.id

string

required

data.media_type

string

optional

image, document, video

data.mime_type

string

optional

data.object

string

optional

media

data.title

string

optional

data.updated_at

string

optional

data.url

string

required

data.usage_context

string

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.variants

object

optional

success

boolean

required

true

Field

Type

Required

Description

media_idpath

string

required

Public media identifier, for example cmda_1234567890ABCDEFGHijk.

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

alt_text

string

optional

caption

string

optional

folder

string

optional

general, categories, services, addons, products, editor, website, branding, forms, vendors

title

string

optional

usage_context

string

optional

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

Field

Type

Required

Description

data

MediaObject

required

data.alt_text

string

optional

data.bytes

integer

optional

data.caption

string

optional

data.created_at

string

optional

data.dimensions

MediaDimensions

optional

data.dimensions.height

integer

optional

data.dimensions.width

integer

optional

data.filename

string

optional

data.folder

string

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.id

string

required

data.media_type

string

optional

image, document, video

data.mime_type

string

optional

data.object

string

optional

media

data.title

string

optional

data.updated_at

string

optional

data.url

string

required

data.usage_context

string

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.variants

object

optional

success

boolean

required

true

curl https://api.getmeonline.io/v1/media/{media_id} \ -X PATCH \ -H "Authorization: Bearer $GETME_API_KEY" \ -H "Idempotency-Key: idem_1234567890abcdef" \ -H "Content-Type: application/json" \ -d '{ "alt_text": "alt_text", "caption": "caption", "folder": "general", "title": "title", "usage_context": "category" }'

Field

Type

Required

Description

media_idpath

string

required

Public media identifier, for example cmda_1234567890ABCDEFGHijk.

Idempotency-Keyheader

string

required

Unique key used to make this mutation retry-safe for the replay window.

Field

Type

Required

Description

data

MediaObject

required

data.alt_text

string

optional

data.bytes

integer

optional

data.caption

string

optional

data.created_at

string

optional

data.dimensions

MediaDimensions

optional

data.dimensions.height

integer

optional

data.dimensions.width

integer

optional

data.filename

string

optional

data.folder

string

required

general, categories, services, addons, products, editor, website, branding, forms, vendors

data.id

string

required

data.media_type

string

optional

image, document, video

data.mime_type

string

optional

data.object

string

optional

media

data.title

string

optional

data.updated_at

string

optional

data.url

string

required

data.usage_context

string

required

category, service, addon, product, subscription, editor, logo, website, branding, forms, general, vendor

data.variants

object

optional

success

boolean

required

true