Skip to main content
POST
/
api
/
portals
/
{portalId}
/
files
/
download
Download file from portal
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/portals/{portalId}/files/download \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "path": "<string>"
}
'
{
  "success": true,
  "url": "<string>",
  "error": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
portalId
integer
required

Portal ID

Body

application/json
​
path
string
required

S3 path (within the portal)

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
url
string
required

Signed URL to download the file

​
error
string

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