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

The OrganizationPipelines API from Edge Impulse — 5 operation(s) for organizationpipelines.

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

This API exposes 8 operations across 5 paths, and defines 18 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.

8 operations 5 paths 18 schemas 1 DELETE3 GET4 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 OrganizationPipelines 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 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

OrganizationPipelines 8
GET
/api/organizations/{organizationId}/pipelines
List pipelines
listOrganizationPipelines 2 params → 200
POST
/api/organizations/{organizationId}/pipelines
Create pipeline
createOrganizationPipeline 1 param body → 200
GET
/api/organizations/{organizationId}/pipelines/archived
List archived pipelines
listArchivedOrganizationPipelines 2 params → 200
GET
/api/organizations/{organizationId}/pipelines/{pipelineId}
Get pipeline
getOrganizationPipeline 2 params → 200
POST
/api/organizations/{organizationId}/pipelines/{pipelineId}
Update pipeline
updateOrganizationPipeline 2 params body → 200
DELETE
/api/organizations/{organizationId}/pipelines/{pipelineId}
Delete pipeline
deleteOrganizationPipeline 2 params → 200
POST
/api/organizations/{organizationId}/pipelines/{pipelineId}/run
Run pipeline
runOrganizationPipeline 3 params → 200
POST
/api/organizations/{organizationId}/pipelines/{pipelineId}/stop
Stop a running pipeline
stopOrganizationPipeline 2 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are OrganizationCreateProject (38 properties), OrganizationPipelineStep (20 properties), OrganizationPipelineRunStep (17 properties), OrganizationPipeline (15 properties). Each schema is shown below with its type and property counts.

OrganizationCreateProject
object
38 properties 19 required
OrganizationCreateProjectOutputDatasetPathRule
string
Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.
TransformationJobOperatesOnEnum
string
ListOrganizationPipelinesResponse
OrganizationPipelineRun
object
7 properties 3 required
GetOrganizationPipelinesResponse
OrganizationDatasetTypeEnum
string
RunOrganizationPipelineResponse
OrganizationPipelineItemCount
object
3 properties 3 required
OrganizationPipeline
object
15 properties 7 required
CreatedUpdatedByUser
object
4 properties 3 required
OrganizationUpdatePipelineBody
object
10 properties 5 required
OrganizationPipelineStep
object
20 properties 1 required
TransformationJobStatusEnum
string
EntityCreatedResponse
OrganizationPipelineRunStep
object
17 properties 2 required
OrganizationCreateProjectPathFilter
object
Filter, given as a dataset and path containing wildcards, used for creating transformation jobs
2 properties 2 required
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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