Download file from portal

Download file from portal

Download a file from an upload portal (requires JWT auth). Will return a signed URL to the bucket.

POSThttps://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/download

Path parameters

portalId*integer

Portal ID

Body

application/json

path*string

S3 path (within the portal)

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

url*string

Signed URL to download the file

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/download', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "path": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "url": "text"
}