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 OrganizationPortals API

The OrganizationPortals API from Edge Impulse — 7 operation(s) for organizationportals.

Edge Impulse OrganizationPortals 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 OrganizationPortals. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 7 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 7 schemas 2 DELETE3 GET1 POST1 PUT

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 OrganizationPortals 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 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

OrganizationPortals 7
GET
/api/organizations/{organizationId}/portals
List upload portals
listOrganizationPortals 1 param → 200
GET
/api/organizations/{organizationId}/portals/{portalId}
Retrieve upload portal information
getOrganizationPortal 2 params → 200
GET
/api/organizations/{organizationId}/portals/{portalId}/verify
Verify upload portal information
verifyOrganizationPortal 2 params → 200
POST
/api/organizations/{organizationId}/portals/create
Create upload portal
createOrganizationPortal 1 param body → 200
PUT
/api/organizations/{organizationId}/portals/{portalId}/update
Update upload portal
updateOrganizationPortal 2 params body → 200
DELETE
/api/organizations/{organizationId}/portals/{portalId}/rotate-token
Rotate upload portal token
rotateOrganizationPortalToken 2 params → 200
DELETE
/api/organizations/{organizationId}/portals/{portalId}/delete
Delete upload portal
deleteOrganizationPortal 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CreateOrganizationPortalRequest (4 properties), GenericApiResponse (2 properties). Each schema is shown below with its type and property counts.

UpdateOrganizationPortalResponse
GetOrganizationPortalResponse
CreateOrganizationPortalRequest
object
4 properties 3 required
CreateOrganizationPortalResponse
VerifyOrganizationBucketResponse
Response object for verifying an organization's bucket connectivity. Workflow: 1. The client initiates verification by sending a GET request to /api/organizati…
ListOrganizationPortalsResponse
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-organizationportals-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