Create upload portal

Create upload portal

Creates a new upload portal for the organization.

post

/api/organizations/{organizationId}/portals/create

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

namestringrequired

The name of the upload portal.

Example: EdgeImpulse Inc.

descriptionstring

The purpose and description of the upload portal.

Example: EdgeImpulse Inc. Portal description

bucketIdintegerrequired

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

Example: 1

bucketPathstringrequired

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

Example: /path/in/bucket

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/portals/create' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"EdgeImpulse Inc.","description":"EdgeImpulse Inc. Portal description","bucketId":1,"bucketPath":"/path/in/bucket"}'

200

200

{
  "success": true,
  "error": "text",
  "id": 1,
  "url": "text",
  "signedUrl": "text",
  "bucketBucket": "text"
}

OK