SearchCtrl+K

Linearize PDF API Reference

Optimize a PDF file for fast web viewing by linearizing (web-optimizing) it.

POST

https://api.apifreaks.com/v1.0/pdf/linearize

The Linearize PDF API restructures a PDF file so that it can be read page-by-page over a network connection without downloading the entire file. This is ideal for serving PDFs on the web where you want viewers to start seeing content immediately.

Getting Started

Authentication

Pass your API key as the apiKey parameter in every request.

API Version

This is version v1.0 of the API.

LANGUAGE

curl --location --request POST 'https://api.apifreaks.com/v1.0/pdf/linearize' \
--header 'X-apiKey: API-KEY' \
--form 'file=@"/path/to/file.pdf"'

Response

{
  "taskId": "04a06cd5-158d-4191-a45b-6f58249c599d",
  "inputIds": [
    "7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f"
  ]
}

API Request Parameters

The following parameters can be used in your API requests. File upload and webhook parameters are passed as multipart form data and query parameters.

file_idoptionalString

The unique ID of a file already present on our server. Use PDF Files API to see your files. Check file metadata using File Status API

destroyoptionalBooleandefault: false

Set to true if you want to permanently delete the original file after processing.

outputoptionalString

Optionally specify a custom name for the output file (without extension).

webhook_urloptionalString

Provide a URL to receive a webhook notification when the task is completed. The notification will include the task status and file ID(s) of the output.

webhook_failure_notificationoptionalBooleandefault: false

If true, we'll send an email notification if the webhook request fails after 3 retries. The email goes to the requesting user or their org admin if user is part of an organization.

Request Headers

Optional custom headers for webhook authorization.

X-Webhook-AuthorizationoptionalString

Custom authorization header sent with the webhook request. Format: Key:Value (e.g., Authorization:Bearer token123).

API Response Schema

A successful request returns a 200 OK response with a JSON object containing the task ID and input file IDs.

taskId

Stringmandatory

Unique identifier for the PDF task, used to check status.

inputIds

Array<String>optional

Array of file IDs referencing input files used for the task. Not returned when destroy=true.

Error Status & Codes

The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.

400

Please provide either a file or a file ID.

400

Please provide a valid file ID

415

The provided file type is not supported. Refer to the documentation for valid file types.