Fetch Media File

GET 
/api/v2/instance/:instanceId/media/:mediaId/file

Retrieves the binary file of a previously prepared media. Supports multiple formats such as images, videos, audios, etc.

Request

Path Parameters

mediaId Media IDrequired

Id of the media that was prepared.

instanceId stringrequired

ID of the instance.

Responses

200

Binary file - Media preview.

application/octet-stream

Schema

Schema

• string binary

application/pdf

Schema

Schema

• string binary

image/jpeg

Schema

Schema

• string binary

audio/ogg

Schema

Schema

• string binary

video/mp4

Schema

Schema

• string binary

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...