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

Quix Streams API

Create and close streams within a topic (Streaming Writer API).

Quix Streams API is one of 9 APIs that Quix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Streams. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 4 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.

2 operations 2 paths 4 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://writer-{environmentId}.cloud.quix.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Quix Streams 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.

Streams 2

Create and close streams within a topic (Streaming Writer API).

POST
/topics/{topicName}/streams
Create a new stream
createStream 1 param body → 200401
POST
/topics/{topicName}/streams/{streamId}/close
Close a stream
closeStream 2 params body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CreateStreamRequest (4 properties), Error (3 properties), CreateStreamResponse (1 property), CloseStreamRequest (1 property). Each schema is shown below with its type and property counts.

CreateStreamRequest
object
Optional metadata for the new stream.
4 properties
CloseStreamRequest
object
1 property
Error
object
3 properties
CreateStreamResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

quix-streams-api-openapi.yml Raw ↑

Other APIs Quix publishes across the network.

Quix Streaming Reader API (Real-time)
Quix Streams (Open Source)
Quix Definitions API
Quix Deployments API
Quix Event Data API
Quix Parameter Data API
Quix Topics API
Quix Workspaces API