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

Inkit Templates API

Manage document templates

Inkit Templates 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 Templates. 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 6 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.

3 operations 2 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.inkit.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Inkit Templates 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.

Templates 3

Manage document templates

POST
/template
Create Template
createTemplate body → 200400401429
GET
/template
List Templates
listTemplates 4 params → 200401429
GET
/template/{id}
Get Template
getTemplate 1 param → 200401404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Template (7 properties), TemplateCreateRequest (5 properties), TemplateData (3 properties), Destination (3 properties). Each schema is shown below with its type and property counts.

Destination
object
Document delivery destination configuration
3 properties
TemplateData
object
Template dimensions and format settings
3 properties
Template
object
7 properties
Error
object
2 properties
TemplateCreateRequest
object
5 properties 2 required
TemplateListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inkit-templates-api-openapi.yml Raw ↑

Other APIs Inkit publishes across the network.

Inkit Batches API
Inkit Documents API
Inkit Folders API
Inkit Renders API