Inkit

Inkit Documents API

Manage stored documents

GitHub OpenAPI

Operations 4

GET /document List Documents #
GET /document/{id} Get Document #
DELETE /document/{id} Delete Document #
GET /download/{id} Download Document #

Documentation

📖
Documentation
https://docs.inkit.com/docs/using-the-api
📖
APIReference
https://docs.inkit.com/reference/post_v1-generate-1

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/inkit/refs/heads/main/openapi/inkit-documents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/inkit/refs/heads/main/json-schema/inkit-render.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/inkit/refs/heads/main/json-schema/inkit-template.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/inkit/refs/heads/main/json-schema/inkit-document.json

Other Resources

🔗
PythonSDK
https://github.com/inkit/inkit-python
🔗
NodejsSDK
https://github.com/inkit/inkit-nodejs
🔗
GoSDK
https://github.com/inkit/inkit-go
🔗
JavaSDK
https://github.com/inkit/inkit-java

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/inkit-documents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

inkit-documents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Inkit Document Generation Batches Documents API
  description: 'The Inkit REST API enables developers to generate PDF documents from HTML templates, manage document storage and retrieval, launch document workflows and batches, and manage digital signature requests. Authentication uses the X-Inkit-API-Token header. The API enforces a rate limit of 300 requests per minute.

    '
  version: 1.0.0
  contact:
    name: Inkit Support
    url: https://docs.inkit.com/docs/welcome-to-inkit
  license:
    name: Proprietary
    url: https://www.inkit.com
servers:
- url: https://api.inkit.com/v1
  description: Inkit Production API
security:
- ApiKeyAuth: []
tags:
- name: Documents
  description: Manage stored documents
paths:
  /document:
    get:
      operationId: listDocuments
      summary: List Documents
      description: Returns a list of stored documents.
      tags:
      - Documents
      parameters:
      - name: search
        in: query
        description: Search term to filter documents
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A list of documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
  /document/{id}:
    get:
      operationId: getDocument
      summary: Get Document
      description: Returns a single document by ID.
      tags:
      - Documents
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          description: Document details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    delete:
      operationId: deleteDocument
      summary: Delete Document
      description: Deletes a document by ID.
      tags:
      - Documents
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '204':
          description: Document deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
  /download/{id}:
    get:
      operationId: downloadDocument
      summary: Download Document
      description: Downloads a document as a PDF file.
      tags:
      - Documents
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          description: PDF file content
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Rate limit exceeded - max 300 requests per minute
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - invalid or missing API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    ResourceId:
      name: id
      in: path
      description: Unique identifier of the resource
      required: true
      schema:
        type: string
  schemas:
    Document:
      type: object
      properties:
        id:
          type: string
          description: Unique document identifier
        name:
          type: string
          description: Document name
        render_id:
          type: string
          description: ID of the render that generated this document
        template_id:
          type: string
          description: ID of the source template
        status:
          type: string
          description: Document status
        created_at:
          type: string
          format: date-time
          description: Document creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Document last update timestamp
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: integer
          description: Error code
    DocumentListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Document'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Inkit-API-Token
      description: API token for Inkit authentication