Quix Definitions API
Declare parameter and event metadata for a stream (Streaming Writer API).
Quix Definitions API is one of 9 APIs that Quix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Definitions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against 2 base URLs: https://writer-{environmentId}.cloud.quix.io, https://portal-api.platform.quix.io.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Quix Definitions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (PAT) (bearerAuth).
bearerAuth— Quix Personal Access Token (PAT) presented as Authorization: Bearer . Generate from the Quix portal under your profile Personal Access Tokens, or Settings APIs…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Declare parameter and event metadata for a stream (Streaming Writer API).
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), ParameterDefinitionsRequest (1 property), EventDefinitionsRequest (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Quix 8
Other APIs Quix publishes across the network.