Skip to main content
cURL
Try it live: PDF Add → API Tester — send a real request from your browser.

POST /v1/pdf/edit/add

Create new PDF forms with fillable edit boxes, checkboxes and other fillable fields. Quickly create configs for PDF.co API, Zapier, Make with PDF.co PDF Edit Add Helper.
To add a signature, save the signature as an image and insert it using the images attribute.
To see the request size limits, please refer to the Request Size Limits.

Request body

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" } There are no query parameters.
string
required
URL to the source file url attribute
string
The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when async is set to true.
string
HTTP auth user name if required to access source URL.
string
HTTP auth password if required to access source URL.
string
Password for the PDF file.
string
File name for the generated output, the input must be in string format.
integer
default:"60"
Set the expiration time for the output link in minutes. After this specified duration, any generated output file(s) will be automatically deleted from PDF.co Temporary Files Storage. The maximum duration for link expiration varies based on your current subscription plan. To store permanent input files (e.g. re-usable images, pdf templates, documents) consider using PDF.co Built-In Files Storage.
boolean
default:"false"
Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated.
boolean
default:"false"
Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks
array[object]
array[object]
array[object]
string
This parameter represents one or more text objects to add to a PDF. Each object is made of parameter separated by the ; symbol.
string
Adds one or more images or other PDF objects on top of the source PDF. Each object is made of parameter separated by the ; symbol.
string
Set values for fillable PDF field objects. Each object is made of parameter separated by the ; symbol. See fieldsString for more information.
object
See Profiles for more information.

Crop a PDF File

Crop a PDF file using an array to define the crop area. The crop box is defined by a rectangle [x, y, width, height] in PDF points (1 Point = 1/72 inches).
An A4 page size in points is 595 x 842

Disable Ligaturization

To disable ligaturization, for example for Hebrew, use the following:

Flatten Document

Flattening a document renders it as read-only. Handy if you want to remove editing or copying capability.

Available fonts

Standard Fonts

Japanese Fonts

Chinese Fonts

Korean Fonts

Hebrew Fonts

Arabic Fonts

Responses

Synchronous response
An asynchronous request returns a jobId and a reserved URL that should be used only after the job succeeds. Poll it via Background Job Check. Errors return error: true with a status code and message. See the response examples and Response Codes.

Example Payload

To see the request size limits, please refer to the Request Size Limits.

Example Response

To see the main response codes, please refer to the Response Codes page.
Inconsistent URL Encoding in cURL Output: When using cURL to make API requests, the output JSON may show URL characters encoded as Unicode escape sequences. For example, the ampersand character (&) may appear as \u0026 in the cURL output. This is normal JSON encoding behavior and does not affect the validity of the URL. The URL will function correctly when used, as JSON parsers automatically decode these escape sequences. If you’re parsing the response programmatically, your JSON parser will handle this conversion automatically.

Create Fillable PDF Forms

You can create fillable PDF forms by adding editable text boxes and checkboxes. By using the annotations[] attribute and setting the type to textfield or checkbox you can create form elements to be placed on your PDF .

Example Payload (Create Fillable PDF Forms)

Example Response (Create Fillable PDF Forms)

CURL

See Fill PDF Forms.