These docs are for v1.7. Click to read the latest docs for v2.1.

Upload Assets

Upload assets such as pictures or a video to design your digital passports.

Before your begin

As a brand, the look and feel of your digital passports matter. Say you want to upload a media that will be integrated into your digital passports.

Because a digital passport has a long life, you must attach long-lived content. Arianee offers a hosting solution for static assets that will last forever.

Use case example: Before creating your digital passports, your brand wants to upload the media that will be displayed for your hoodie, two pictures, and an AR asset.

โ›”

Limitations

  • Each asset size is limited to 10mb.
  • AR assets are only available on iOS devices.
  • For connection latency, if the upload exceeds 60 seconds, it expires and returns an error.

Let's start ๐Ÿš€

To upload and store a picture in your environment, use assets/pub.

๐Ÿ“Œ

The API is authenticated with the user rights required โ†’ assetsUpload

InputMandatoryTypeDescription
fileNameโœ…StringMedia file.

Supported formats:
- Pictures: .png, .jpeg, .jpg, .svg, .gif
Optimal resolution: 2000x2000
- Video: .mp4
- 3D asset: .glb, .gltf
- AR asset: .usdz
fileIdโœ…StringGenerated picture identification number.
resizeโŒBooleanAuto resizing of the picture.
curl --request POST \
     --url https://documentation.arianee.com/assets/pub \
     --header 'accept: application/json' \
     --header 'content-type: multipart/form-data' \
     --header 'x-api-key: string' \
     --form fileId=newlogo \
     --form image=@2303c46f-f0f5-4a05-a5ad-82906c78e4db_900x900.jpg

Result: Your picture has been uploaded.

{
  "url": "https://documentation.arianee.com/pub/arianeelogo_black",
  "message": "Your file arianee_logo_BLACK.jpeg has been updated"
}