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 Documents API

Manage stored documents

Inkit Documents 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 Documents. 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 3 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.

4 operations 3 paths 3 schemas 1 DELETE3 GET

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 Documents 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 — 1 DELETE, 3 GET. Each is listed below with its method, path, parameters, and response codes.

Documents 4

Manage stored documents

GET
/document
List Documents
listDocuments 1 param → 200401429
GET
/document/{id}
Get Document
getDocument 1 param → 200401404429
DELETE
/document/{id}
Delete Document
deleteDocument 1 param → 204401404429
GET
/download/{id}
Download Document
downloadDocument 1 param → 200401404429

Schemas 3

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

DocumentListResponse
object
1 property
Error
object
2 properties
Document
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inkit-documents-api-openapi.yml Raw ↑

Other APIs Inkit publishes across the network.

Inkit Batches API
Inkit Folders API
Inkit Renders API
Inkit Templates API