Classify9

Deployment16

Devices13

DSP18

EmailVerification1

Export2

Impulse17

Integrations2

Jobs44

Learn26

Login2

Optimization17

OrganizationBlocks30

OrganizationCreateProject15

OrganizationData40

OrganizationDataCampaigns11

OrganizationJobs8

OrganizationPipelines8

OrganizationPortals7

Organizations74

PerformanceCalibration10

PostProcessing4

Projects60

Raw data65

UploadPortal7

User48

Whitelabels3

OrganizationPortals

Create upload portal

Creates a new upload portal for the organization.

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

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/portals/create/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Request body

namestring required

The name of the upload portal.

descriptionstring

The purpose and description of the upload portal.

bucketIdinteger required

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

bucketPathstring required

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

Example request

{
  "name": "EdgeImpulse Inc.",
  "description": "EdgeImpulse Inc. Portal description",
  "bucketId": 1,
  "bucketPath": "/path/in/bucket"
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Portal ID for the new upload portal

urlstring required

URL to the portal

signedUrlstring

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

bucketBucketstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.