v3

latestSwagger 2.02026-08-067506752.0 MB
media

Returns metadata about a piece of media

get/v1/org/{orgId}/media/{mediaId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

mediaIdstring required

Media id

Response

successful operation

idstring required

globally unique id of media

orgIdstring

parent org id, if the media belongs to an organization

pathstring required

path to the file in media S3 bucket

typestring required

mime type of file

bytesinteger

size of file in bytes

widthinteger

width of image in pixels

heightinteger

height of image in pixels

versionsstring[] required

versions/sizes available

createIdstring required

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring required

created timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "path": "588f7ee98f138b19220041a7/2017/02/21/588f7ee98f138b19220041a7/avatar.png",
  "type": "image/jpeg",
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z"
}