Inkit Renders API
Generate and retrieve document renders (PDFs)
Inkit Renders API is one of 5 APIs that Inkit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Renders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 3 JSON Schemas.
This API exposes 4 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.inkit.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Inkit Renders API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Inkit-API-Token (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— API token for Inkit authentication
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Generate and retrieve document renders (PDFs)
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Render (7 properties), RenderCreateRequest (3 properties), Destination (3 properties), Error (2 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 Inkit 4
Other APIs Inkit publishes across the network.