Substy Developers
Media and vault

Read media bytes

Read a creator vault media file by creatorId and mediaId. Choose full, preview or thumb; offset and maxBytes are byte counts. Returns base64 content, contentType, byteLength and nextOffset. Continue from nextOffset until null to retrieve the whole file; each call reads at most 1 MiB.

GET/v1/agencies/{agencyId}/creators/{creatorId}/media/{mediaId}/bytes

Read a creator vault media file by creatorId and mediaId. Choose full, preview or thumb; offset and maxBytes are byte counts. Returns base64 content, contentType, byteLength and nextOffset. Continue from nextOffset until null to retrieve the whole file; each call reads at most 1 MiB.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string
Length1 <= length
mediaId*string
Length1 <= length

Query Parameters

variant?string
Default"full"

Value in

  • "full"
  • "preview"
  • "thumb"
offset?integer
Range0 <= value <= 9007199253692414
Default0
maxBytes?integer
Range1 <= value <= 1048576
Default262144

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/creators/string/media/string/bytes" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "base64": "string",    "contentType": "string",    "offset": 0,    "byteLength": 0,    "totalBytes": null,    "nextOffset": null  },  "meta": {    "requestId": "string"  }}