Inklok API Specification

Canonical OpenAPI v3 specification for the Inklok public API.

This package contains the API contract used by Inklok developer tools, SDKs, and integrations. It defines available endpoints, request and response schemas, authentication requirements, and shared API components.

Installation

Install the specification package from npm:

npm install @inklok/api-spec

Usage

The specification can be used to:

• Generate API clients
• Generate strongly typed models
• Validate requests and responses
• Build custom integrations
• Keep integrations aligned with the Inklok API contract

Example:

import fs from "node:fs";

const openapi = fs.readFileSync(
  "node_modules/@inklok/api-spec/openapi.yaml",
  "utf8"
);

console.log(openapi);

API Documentation

The interactive API reference is available at:

https://docs.inklok.com/docs/api-reference

The API reference includes:

• Endpoint documentation
• Authentication requirements
• Request and response schemas
• Example requests and responses
• Interactive API exploration

API Endpoint

The production Inklok API endpoint is:

https://api.inklok.com

SDK clients and integrations should use this as the API base URL.

Package Contents

This package contains:

openapi.yaml
components/
  schemas.yaml
  responses.yaml
  security.yaml
package.json

Specification Details

This package follows the OpenAPI specification format.

It defines:

• API paths and operations
• Request parameters
• Request bodies
• Response schemas
• Authentication schemes
• Shared response definitions

Authentication

The Inklok API uses authenticated requests.

Supported authentication methods include:

• User access tokens
• Inklok API keys

See the API reference for authentication details and examples.

API Versioning

The Inklok API uses versioned endpoints.

New API capabilities are introduced using version prefixes:

/v1/agreements
/v1/documents

Applications should use the versioned API paths documented in the API reference.

Validation

To validate the specification locally:

npm install
npm run validate-basic

Consuming Updates

The package is published as:

@inklok/api-spec

Install:

npm install @inklok/api-spec

New versions are released as the Inklok API evolves.

Related Resources

API Reference: https://docs.inklok.com/docs/api-reference

Inklok: https://inklok.com

License

See package metadata for licensing information.