Introduction

The DIPSAC API is a REST API that accepts standard HTTP requests and returns responses in JSON or binary format depending on the endpoint. All file inputs are sent as multipart/form-data.

The API is currently in Beta. Endpoints are stable but response schemas may evolve. Subscribe to our changelog for updates.

Authentication

All API requests require an API key passed in the X-API-Key request header.

HTTP Header

X-API-Key: dps_your_api_key_here

Never expose your API key in client-side code or public repositories. Rotate keys immediately if compromised via the dashboard.

Get your free API key →

Base URL & Versioning

All API endpoints are versioned. The current stable version is v1.

Base URL

https://api.dipsac.com/v1

Version is included in the path, not a header. When a new version is released, v1 will remain supported for at least 12 months.

Quick Start

Convert a PDF to Word in your preferred language:

# Convert PDF to Word
curl -X POST https://api.dipsac.com/v1/pdf/convert \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "output_format=docx" \
  --output converted.docx

POST/v1/pdf/convert

PDF Convert

Convert a PDF to Word (.docx), Excel (.xlsx), plain text (.txt), or images (.png/.jpg).

Request

ParameterTypeRequiredDescription

fileFileYesThe PDF file to convert (max 50 MB on Pro)

output_formatstringYesTarget format: docx, xlsx, txt, png, jpg

qualityintegerNoImage quality 1–100 (for png/jpg output, default 85)

Response

Returns the converted file as a binary stream with the appropriate Content-Type header.

Response Headers

Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Content-Disposition: attachment; filename="converted.docx"
X-Processing-Time: 287ms

POST/v1/pdf/compress

PDF Compress

Reduce PDF file size while preserving visual quality.

ParameterTypeRequiredDescription

fileFileYesThe PDF to compress (max 50 MB)

levelstringNoCompression level: low, medium, high (default: medium)

POST/v1/pdf/merge

PDF Merge

Combine multiple PDFs into a single document.

ParameterTypeRequiredDescription

files[]File[]YesArray of PDF files to merge (2–20 files, max 100 MB total)

orderstringNoJSON array of indices to control merge order, e.g. [2,0,1]

POST/v1/image/convert

Image Convert

Convert images between formats: JPG, PNG, WebP, AVIF, BMP, TIFF, HEIC.

ParameterTypeRequiredDescription

fileFileYesSource image file

output_formatstringYesjpg, png, webp, avif, bmp, tiff

qualityintegerNoCompression quality 1–100 (default: 85)

POST/v1/dev/json/format

JSON Format

Format, validate, or minify JSON. Returns JSON.

Request body (application/json)

{
  "input": "{"name":"DIPSAC","free":true}",
  "action": "format",    // "format" | "minify" | "validate"
  "indent": 2
}

Response

{
  "output": "{\"name\": \"DIPSAC\",\"free\": true}",
  "valid": true,
  "size_before": 28,
  "size_after": 36
}

Error Codes

All errors return a JSON body with error and message fields:

Error response

{
  "error": "unsupported_format",
  "message": "The file format 'bmp' is not supported for this endpoint.",
  "docs": "https://dipsac.com/docs#error-codes"
}

HTTP CodeError TypeDescription

400bad_requestMissing or invalid request parameters

401unauthorizedInvalid or missing API key

403forbiddenAPI key does not have access to this endpoint

413file_too_largeFile exceeds the size limit for your plan

422unsupported_formatFile format not supported for this operation

429rate_limitedYou have exceeded your request rate limit

500server_errorUnexpected server error — please retry

Rate Limits

Rate limits are applied per API key per rolling 60-second window:

Free2 req/sec500 req/month

Pro20 req/sec50,000 req/month

Enterprise100 req/secUnlimited

When rate-limited, the API returns 429 Too Many Requests with a Retry-After header indicating seconds to wait.

File Size Limits

Free5 MB per file20 pages (PDF)

Pro50 MB per file500 pages (PDF)

Enterprise500 MB per fileUnlimited

SDKs & Libraries

Official SDKs are coming soon. In the meantime, use our REST API directly with any HTTP client.

Node.js

Coming soon

Python

Coming soon

PHP

Coming soon

Ruby

Coming soon

Java

Coming soon

Want us to prioritise your language? Let us know →