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

The Canary API from Edge Impulse — 1 operation(s) for canary.

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

This API exposes 1 operation across 1 path, and defines 2 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.

1 operations 1 paths 2 schemas 1 GET

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 Canary 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Canary 1
GET
/api/canary
Get the decision to whether the requested URL goes on canary deployment or not
shouldGoOnCanary 1 param → 200

Schemas 2

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

GenericApiResponse
object
2 properties 1 required
CanaryResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth 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
Edge Impulse Impulse API