Inkit · Schema

Inkit Render

A document render generated by the Inkit Document Generation API

Document GenerationPDFTemplatesDigital SignaturesWorkflowsDocument ManagementSecure DocumentsComplianceHIPAAEnterprise

Properties

Name	Type	Description
id	string	Unique render identifier
template_id	string	ID of the source template used for this render
merge_parameters	object	Key-value pairs merged into the template during render
destinations	array	Delivery destinations for the rendered document
status	string	Current render status
created_at	string	Render creation timestamp
updated_at	string	Render last update timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/inkit/json-schema/inkit-render.json",
  "title": "Inkit Render",
  "description": "A document render generated by the Inkit Document Generation API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique render identifier"
    },
    "template_id": {
      "type": "string",
      "description": "ID of the source template used for this render"
    },
    "merge_parameters": {
      "type": "object",
      "description": "Key-value pairs merged into the template during render",
      "additionalProperties": true
    },
    "destinations": {
      "type": "array",
      "description": "Delivery destinations for the rendered document",
      "items": {
        "$ref": "#/definitions/Destination"
      }
    },
    "status": {
      "type": "string",
      "description": "Current render status",
      "enum": ["pending", "processing", "completed", "failed"]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Render creation timestamp"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Render last update timestamp"
    }
  },
  "required": ["id", "template_id"],
  "definitions": {
    "Destination": {
      "type": "object",
      "description": "Document delivery destination",
      "properties": {
        "name": {
          "type": "string",
          "description": "Destination name",
          "enum": ["s3", "box", "dropbox", "google_drive", "sepire"]
        },
        "status": {
          "type": "string",
          "description": "Delivery status for this destination"
        },
        "data": {
          "type": "object",
          "description": "Destination-specific configuration",
          "additionalProperties": true
        }
      }
    }
  }
}