Skip to content

PDF and Export API

API Key

The PDF and Export API provides endpoints for exporting processed documents in different formats. These endpoints allow you to convert your processed content into PDF, JSON, or Markdown formats for easy sharing and distribution.

API Endpoints

Get JSON Format

GET /pdf/ID/json

Retrieve a document in JSON format.

Terminal window
curl -X GET https://api.shrinked.com/pdf/doc123456/json?includeReferences=true \
-H "x-api-key: YOUR_API_KEY"

Get Markdown Format

GET /pdf/ID/markdown

Retrieve a document in Markdown format.

Terminal window
curl -X GET https://api.shrinked.com/pdf/doc123456/markdown?includeReferences=true \
-H "x-api-key: YOUR_API_KEY"

Get PDF Document

GET /pdf/ID/document

Download a document in PDF format.

Terminal window
curl -X GET https://api.shrinked.com/pdf/doc123456/document?template=report \
-H "x-api-key: YOUR_API_KEY" \
--output document.pdf

PDF Customization Options

When generating PDF documents, you can customize various aspects of the output:

Templates

default

Standard template with basic formatting

report

Business report layout with table of contents

transcript

Optimized for transcripts with speaker identification

article

Magazine-style layout for content

Additional Options

OptionTypeDescription
fontSizestringFont size for body text (e.g., “12pt”)
fontFamilystringFont family (e.g., “Arial”, “Times”)
includeTimestampsbooleanWhether to include media timestamps
includeTocbooleanWhether to include table of contents
headerTextstringCustom header text
footerTextstringCustom footer text

Example Request with Customization

Terminal window
curl -X GET "https://api.shrinked.com/pdf/doc123456/document?template=report&fontSize=11pt&fontFamily=Arial&includeToc=true" \
-H "x-api-key: YOUR_API_KEY" \
--output document.pdf

Export Formats

JSON

Structured data format for programmatic use

/pdf/ID/json
#

Markdown

Text-based markup for content editing

/pdf/ID/markdown
PDF

PDF

Portable Document Format for distribution

/pdf/ID/document
</>

HTML

Web format for online viewing

/pdf/ID/htmlComing Soon
W

DOCX

Microsoft Word format

/pdf/ID/docxComing Soon

Usage Limits

  • Maximum 100 export requests per hour per API key
  • PDF generation limited to 50MB per document
  • Concurrent exports limited to 5 per account

Contact support to increase these limits for your account.