Skip to main content

Documentation

Everything you need to know about using NisPdf. Browse guides, API references, and tutorials.

Getting Started
Learn the basics of NisPdf and get up and running quickly.
PDF Tools
Detailed guides for each PDF processing tool.
AI Features
Guides for AI-powered document processing capabilities.
API Reference
Integrate NisPdf tools into your own applications.
Security & Privacy
Learn how we protect your documents and data.
Help & Support
Get help when you need it.

Quick Start Guide

  1. Create an account or sign in.
  2. Pick a tool from the tools list, for example Merge.
  3. Add your PDF files, set any options, and run the operation.
  4. Download the result.

API Overview

NisPdf tools are backed by a REST API under /api/v1. File operations accept multipart/form-data and return either a PDF, a ZIP archive or JSON, depending on the operation.

API Authentication

Authenticated endpoints use httpOnly session cookies set at sign-in; send requests with credentials included. Sign-in is available through POST /auth/login or the Keycloak OAuth flow (GET /auth/keycloak/authorize), and POST /auth/logout clears the session.

PDF Operations API

  • POST /pages/merge: files (multiple PDFs), returns a PDF.
  • POST /pages/split: file, optional pages, returns a ZIP of PDFs.
  • POST /pages/extract: file, pages (e.g. 1-3,5,7-10), returns a PDF.
  • POST /pages/rotate: file, pages, rotation (90, 180 or 270), returns a PDF.

API Errors

Failures return { "success": false, "error": "...", "code": "..." }. Common codes: INVALID_FILE, FILE_TOO_LARGE, UNSUPPORTED_FORMAT, PROCESSING_ERROR, AUTHENTICATION_ERROR, RATE_LIMIT_EXCEEDED and QUOTA_EXCEEDED.

Security Overview

  • Sessions use httpOnly cookies, so page scripts cannot read them.
  • Uploaded files are validated for type and size.
  • Production traffic is served over HTTPS.

FAQ

Which file types can I process?
PDF files for most tools. Unsupported or corrupted files are rejected with a clear error.
Where do I see plan limits?
On the pricing page.
I found a problem. Who do I tell?
Email support@nispdf.com.