Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
portals
/
create
Create upload portal
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "EdgeImpulse Inc.",
  "bucketId": 1,
  "bucketPath": "/path/in/bucket",
  "description": "EdgeImpulse Inc. Portal description"
}
'
{
  "success": true,
  "id": 123,
  "url": "<string>",
  "error": "<string>",
  "signedUrl": "<string>",
  "bucketBucket": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
organizationId
integer
required

Organization ID

Body

application/json
​
name
string
required

The name of the upload portal.

Example:

"EdgeImpulse Inc."

​
bucketId
integer
required

The S3 bucket id to store the uploaded data. Set to '0' to select a bucket hosted by Edge Impulse.

Example:

1

​
bucketPath
string
required

The path in the bucket the upload portal will write to.

Example:

"/path/in/bucket"

​
description
string

The purpose and description of the upload portal.

Example:

"EdgeImpulse Inc. Portal description"

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

Portal ID for the new upload portal

​
url
string
required

URL to the portal

​
error
string

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

​
signedUrl
string

pre-signed upload URL. Only set if using a non-built-in bucket.

​
bucketBucket
string

Only set if using a non-built-in bucket.