Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse UploadPortal API

The UploadPortal API from Edge Impulse — 7 operation(s) for uploadportal.

Edge Impulse UploadPortal API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UploadPortal. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

7 operations 7 paths 11 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse UploadPortal API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

UploadPortal 7
GET
/api/portals/{portalId}
Portal info
getPortalInfo 1 param → 200
POST
/api/portals/{portalId}/upload-link
Create pre-signed S3 upload link
createSignedUploadLink 1 param body → 200
POST
/api/portals/{portalId}/files
List files in portal
listPortalFilesInFolder 1 param body → 200
POST
/api/portals/{portalId}/files/delete
Delete file from portal
deletePortalFile 1 param body → 200
POST
/api/portals/{portalId}/files/rename
Rename file from portal
renamePortalFile 1 param body → 200
POST
/api/portals/{portalId}/files/download
Download file from portal
downloadPortalFile 1 param body → 200
GET
/api/portals/{portalId}/files/view
View file from portal
viewPortalFile 2 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PortalInfoResponse (6 properties), PortalFile (6 properties), ListPortalFilesInFolderRequest (3 properties), CreateSignedUploadLinkRequest (3 properties). Each schema is shown below with its type and property counts.

ListPortalFilesInFolderResponse
DownloadPortalFileRequest
object
1 property 1 required
ListPortalFilesInFolderRequest
object
3 properties 1 required
CreateSignedUploadLinkRequest
object
3 properties 3 required
DeletePortalFileRequest
object
1 property 1 required
CreateSignedUploadLinkResponse
PortalFile
object
6 properties 3 required
PortalInfoResponse
object
6 properties 6 required
RenamePortalFileRequest
object
2 properties 2 required
GenericApiResponse
object
2 properties 1 required
DownloadPortalFileResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-uploadportal-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API