Build with the Inkwell API

Access articles, authors, analytics, and publishing workflows through a clean, RESTful interface. Designed for developers, built for scale.

const inkwell = require('@inkwell/api'); // Initialize client const client = new inkwell.Client({ apiKey: 'iw_live_8f3k29d...', version: 'v1' }); // Fetch latest posts const posts = await client.posts.getAll({ limit: 20, category: 'technology', sort: 'published_desc' }); console.log(`Found ${posts.length} articles`);
Platform Capabilities

Everything You Need to Integrate

Robust tools designed for modern applications

RESTful & GraphQL

Full REST API with optional GraphQL endpoint for flexible data querying and reduced over-fetching.

🔑

OAuth 2.0 & API Keys

Enterprise-grade authentication with role-based access, scoped tokens, and automatic rotation.

📡

Real-time Webhooks

Subscribe to events like new posts, analytics updates, and moderation flags with retry logic.

📊

Analytics Endpoint

Access reader metrics, engagement heatmaps, and SEO performance data programmatically.

🛡️

Rate Limiting & Quotas

1000 req/min default with burst allowance. Transparent headers and auto-scaling tiers.

🧩

Extensible SDKs

Official libraries for Node.js, Python, Go, and PHP with full TypeScript definitions.

Get Started

Authentication & First Request

Secure your connection and make your first API call in minutes

curl -X GET "https://api.inkwell.dev/v1/posts" \
  -H "Authorization: Bearer iw_live_8f3k29d..." \
  -H "Content-Type: application/json" \
  -d '{"limit": 10, "sort": "published_desc"}'
const inkwell = require('@inkwell/api');

const client = new inkwell.Client({
  apiKey: process.env.INKWELL_API_KEY
});

const posts = await client.posts.getAll();
console.log(posts);
from inkwell import Client

client = Client(api_key="iw_live_8f3k29d...")

posts = client.posts.get_all(limit=10)
print(posts)
Reference

API Endpoints

Core resources for content, users, and analytics

Method Endpoint Description Auth Required
GET /v1/posts List published articles with pagination & filters Optional
POST /v1/articles Create new draft or publish directly Required (Editor/Owner)
GET /v1/users/:id Retrieve author profile & metadata Optional
PUT /v1/analytics/report Generate custom engagement metrics Required (Admin)
DELETE /v1/webhooks/:id Remove active webhook subscription Required (Owner)
Libraries

Official SDKs

Install and integrate in your preferred language

Node.js

Async/await ready, TypeScript support

npm install @inkwell/api

Python

Requests-based, Pydantic models

pip install inkwell-sdk

Go

High performance, stdlib compatible

go get github.com/inkwell/api-go

PHP

Composer ready, Laravel integration

composer require inkwell/sdk
Developer Support

Resources & Status

Stay informed and get help when you need it

All Systems Operational

API Status Dashboard

Real-time uptime monitoring, incident history, and maintenance schedules.

View Status

📖 Full Documentation

Interactive reference guides, SDK examples, webhook schema, and migration paths.

Read Docs

💬 Developer Community

Join our Discord for real-time support, feature requests, and SDK contributions.

Join Discord
"}