Inkit Batches API
Batch document render operations
Inkit Batches 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 Batches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 3 JSON Schemas.
This API exposes 3 operations across 2 paths, and defines 7 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 Batches 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 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Batch document render operations
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Render (7 properties), Batch (6 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.