Knock Guides API
Guides let you define in-app guides that can be displayed to users based on priority and other conditions.
Knock Guides API is one of 35 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Guides. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.
This API exposes 15 operations across 12 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://api.knock.app.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Knock Guides API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
BearerAuth— Knock API key as a Bearer token. Use a public key (pk...) for client-side requests or a secret key (sk...) for server-side.
Paths & Operations 15
Across 12 paths, the API surfaces 15 operations — 2 DELETE, 3 GET, 10 PUT. Each is listed below with its method, path, parameters, and response codes.
Guides let you define in-app guides that can be displayed to users based on priority and other conditions.
Schemas 13
The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Guide (18 properties), GuideRequest (9 properties), GuideActionRequest (9 properties), GuideStep (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Knock 12
Other APIs Knock publishes across the network.