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

The OrganizationJobs API from Edge Impulse — 8 operation(s) for organizationjobs.

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

This API exposes 8 operations across 8 paths, and defines 6 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 8 paths 6 schemas 7 GET1 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 OrganizationJobs 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 8 paths, the API surfaces 8 operations — 7 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

OrganizationJobs 8
GET
/api/organizations/{organizationId}/jobs
List active jobs
listActiveOrganizationJobs 2 params → 200
GET
/api/organizations/{organizationId}/jobs/history
List finished jobs
listFinishedOrganizationJobs 6 params → 200
GET
/api/organizations/{organizationId}/jobs/all
List all jobs
listAllOrganizationJobs 9 params → 200
POST
/api/organizations/{organizationId}/jobs/{jobId}/cancel
Cancel job
cancelOrganizationJob 3 params → 200
GET
/api/organizations/{organizationId}/jobs/{jobId}/status
Get job status
getOrganizationJobStatus 2 params → 200
GET
/api/organizations/{organizationId}/jobs/{jobId}/stdout
Get logs
getOrganizationJobsLogs 4 params → 200
GET
/api/organizations/{organizationId}/jobs/{jobId}/stdout/download
Download logs
downloadOrganizationJobsLogs 4 params → 200
GET
/api/organizations/{organizationId}/socket-token
Get socket token for an organization
getOrganizationSocketToken 1 param → 200

Schemas 6

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

Job
object
12 properties 5 required
LogStdoutResponse
SocketTokenResponse
ListJobsResponse
GetJobResponse
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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