Inkit

Inkit Batches API

Batch document render operations

GitHub OpenAPI

Operations 3

POST /batch Create Batch #
GET /batch List Batches #
GET /batch/{id} Get Batch #

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/inkit/openapi/inkit-batches-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/inkit/json-schema/inkit-render.json
📊
JSONSchema
https://artifacts.apis.io/inkit/json-schema/inkit-template.json
📊
JSONSchema
https://artifacts.apis.io/inkit/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
🔗
APIsJSON
https://artifacts.apis.io/inkit/apis.yml

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:inkit-batches-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-batches-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Inkit Document Generation Batches 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: Batches
  description: Batch document render operations
paths:
  /batch:
    post:
      operationId: createBatch
      summary: Create Batch
      description: Creates a batch of document renders from a single template.
      tags:
      - Batches
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateRequest'
      responses:
        '200':
          description: Batch created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Batch'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
    get:
      operationId: listBatches
      summary: List Batches
      description: Returns a list of batch render jobs.
      tags:
      - Batches
      parameters:
      - name: destination_name
        in: query
        description: Filter by destination name
        required: false
        schema:
          type: string
      responses:
        '200':
          description: A list of batches
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
  /batch/{id}:
    get:
      operationId: getBatch
      summary: Get Batch
      description: Returns a single batch by ID.
      tags:
      - Batches
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          description: Batch details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Batch'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: integer
          description: Error code
    Batch:
      type: object
      properties:
        id:
          type: string
          description: Unique batch identifier
        template_id:
          type: string
          description: ID of the source template
        renders:
          type: array
          items:
            $ref: '#/components/schemas/Render'
        status:
          type: string
          description: Overall batch status
        created_at:
          type: string
          format: date-time
          description: Batch creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Batch last update timestamp
    BatchCreateRequest:
      type: object
      required:
      - template_id
      - renders
      properties:
        template_id:
          type: string
          description: ID of the template to use for all renders in the batch
        renders:
          type: array
          description: List of render items with individual merge parameters and destinations
          items:
            $ref: '#/components/schemas/BatchRenderItem'
    BatchListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Batch'
    Render:
      type: object
      properties:
        id:
          type: string
          description: Unique render identifier
        template_id:
          type: string
          description: ID of the source template
        merge_parameters:
          type: object
          additionalProperties: true
          description: Merge parameters used for this render
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
        status:
          type: string
          description: Current render status
        created_at:
          type: string
          format: date-time
          description: Render creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Render last update timestamp
    BatchRenderItem:
      type: object
      properties:
        merge_parameters:
          type: object
          description: Merge parameters for this individual render in the batch
          additionalProperties: true
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
    Destination:
      type: object
      description: Document delivery destination configuration
      properties:
        name:
          type: string
          description: Destination name (e.g. s3, box, dropbox, google_drive, sepire)
        status:
          type: string
          description: Current delivery status
        data:
          type: object
          description: Destination-specific configuration data
          additionalProperties: true
  responses:
    Unauthorized:
      description: Unauthorized - invalid or missing API token
      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'
    BadRequest:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Inkit-API-Token
      description: API token for Inkit authentication