PDF Generator API

https://docs.pdfgeneratorapi.com
Admin
PDF Generator API is a web-based service for generating transactional PDF documents with a...
Tokens:37,557
Snippets:252
Trust Score:8.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create Form Response Example

Source: https://docs.pdfgeneratorapi.com/v4

Example of a successful response when creating a form, detailing the newly created form's configuration.

```json
{
  "response": {
    "id": 1,
    "template_id": 123123,
    "name": "Certificate creator",
    "actions": [
      {
        "store_document": true
}
],
    "fields": [
      {
        "label": "Full name",
        "name": "name",
        "type": "text",
        "required": false
}
],
    "configuration": {
      "title": "Employment application",
      "intro": "Please fill in all required fields.",
      "outro": "Thank you for your submission."
}
}

}
```

--------------------------------

### Service Status Response Example

Source: https://docs.pdfgeneratorapi.com/v4

Example JSON response indicating the status of different API components. All services are reported as 'ok'.

```json
{
  * "api": "ok",
  * "chart-api": "ok",
  * "conversion-api": "ok",
  * "generator-api-sync": "ok",
  * "generator-api-async": "ok",
  * "e-invoice": "ok"

}
```

--------------------------------

### Generate Document Response Example

Source: https://docs.pdfgeneratorapi.com/v4

This is an example of a successful response when generating a document. The 'response' field contains the base64 encoded document, and 'meta' provides details like the document name and public ID.

```json
{
  "response": "JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...",
  "meta": {
    "name": "a2bd25b8921f3dc7a440fd7f427f90a4.pdf",
    "display_name": "a2bd25b8921f3dc7a440fd7f427f90a4",
    "encoding": "base64",
    "content-type": "application/pdf",
    "public_id": "a2bd25b8921f3dc7a440fd7f427f90a4"
}

}
```

--------------------------------

### Get Form Request (Shell + Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Example cURL command to retrieve the configuration of a specific form using its ID. Remember to replace 'REPLACE_BEARER_TOKEN' with your actual authentication token.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/forms/1 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Complete JWT Example

Source: https://docs.pdfgeneratorapi.com/v4

Shows a fully formed JWT with encoded header, payload, and signature, separated by dots.

```plaintext
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q

// Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
// Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0
// Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q
```

--------------------------------

### Example JSON Data Structure

Source: https://docs.pdfgeneratorapi.com/v4

This is an example of the JSON data structure that can be used with the API. Data fields are accessed using '::' as a separator.

```json
{
    "documentNumber": 1,
    "paymentDetails": {
        "method": "Credit Card",
        "buyerName": "John Smith"
    },
    "items": [
        {
            "id": 1,
            "name": "Item one"
        }
    ]
}
```

--------------------------------

### List Templates using Curl

Source: https://docs.pdfgeneratorapi.com/v4

Use this endpoint to retrieve a list of available templates from the library. Requires a GET request to the specified URL.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/library
```

--------------------------------

### Get Template Request Sample (cURL)

Source: https://docs.pdfgeneratorapi.com/v4

This cURL command demonstrates how to retrieve a specific template's configuration using its ID. Replace 'REPLACE_BEARER_TOKEN' with your actual authentication token.

```bash
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/19375 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get template library

Source: https://docs.pdfgeneratorapi.com/v4

Returns a list of publicly available templates from the template library. Requires JSON Web Token authentication.

```APIDOC
## Get template library 
Returns a list of publicly available templates from the template library.
### Method
GET
### Endpoint
/api/v4/templates/library
### Responses
#### Success Response (200)
- Returns a list of public templates
##### Response Schema: application/json
- **response** (Array of objects) - (PublicTemplateLibraryItem)
#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
- **422** Unprocessable Entity
- **429** Too Many Requests
- **500** Internal Server Error
```

--------------------------------

### Authentication Failed Response

Source: https://docs.pdfgeneratorapi.com/v4

This is an example of an authentication failure response. Ensure your authorization token is correctly provided.

```json
{
  "message": "Authentication failed"
}
```

--------------------------------

### Copy Template Response Body

Source: https://docs.pdfgeneratorapi.com/v4

Example response when a template is successfully copied. It includes the details of the newly created template.

```json
{
  "response": {
    "id": 19375,
    "name": "Invoice template",
    "tags": [
      "invoice",
      "orders"
    ],
    "isDraft": true,
    "layout": {
      "format": "A4",
      "width": 21,
      "height": 29.7,
      "unit": "cm",
      "orientation": "portrait",
      "rotation": 0,
      "margins": {
        "top": 0.5,
        "right": 0.5,
        "bottom": 0.5,
        "left": 0.5
      },
      "repeatLayout": {
        "format": "A4",
        "width": 21,
        "height": 29.7
      },
      "emptyLabels": 0
    },
    "pages": [
      {
        "width": 21,
        "height": 29.7,
        "margins": {
          "right": 0.5,
          "bottom": 0.5
        },
        "components": [
          {}
]
}
],
    "dataSettings": {
      "sortBy": [
        {}
],
      "filterBy": [
        {}
]
},
    "editor": {
      "heightMultiplier": 2
}
},
  "meta": {}
}
```

--------------------------------

### GET /templates/{templateId}/versions/{templateVersion}

Source: https://docs.pdfgeneratorapi.com/v4

Returns the template definition of the specified version.

```APIDOC
## GET /templates/{templateId}/versions/{templateVersion}

### Description
Returns the template definition of the specified version.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates/{templateId}/versions/{templateVersion}

### Parameters
#### Path Parameters
- **templateId** (integer) - Required - Template unique identifier
- **templateVersion** (integer) - Required - Unique ID of the template version.

### Request Example
```bash
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions/%7BtemplateVersion%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **response** (object (TemplateDefinition)) - Template configuration.
- **meta** (object)

#### Response Example
(Response example not provided in source)
```

--------------------------------

### Get Template

Source: https://docs.pdfgeneratorapi.com/v4

Returns the configuration of a specific template by its ID. Requires JSONWebTokenAuth.

```APIDOC
## GET /templates/{templateId}

### Description
Returns template configuration.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates/{templateId}

### Parameters
#### Path Parameters
- **templateId** (integer) - Required - Example: 19375 - Template unique identifier

### Response
#### Success Response (200)
Template configuration
##### Response Schema: application/json
```json
{
  "response": {
    "id": 19375,
    "name": "Invoice template",
    "tags": [
      "invoice",
      "orders"
    ],
    "isDraft": true,
    "layout": {
      "format": "A4",
      "width": 21,
      "height": 29.7,
      "unit": "cm",
      "orientation": "portrait",
      "rotation": 0,
      "margins": {
        "top": 0.5,
        "right": 0.5,
        "bottom": 0.5,
        "left": 0.5
      },
      "repeatLayout": {
        "format": "A4",
        "width": 21,
        "height": 29.7
      },
      "emptyLabels": 0
    },
    "pages": [
      {
        "width": 21,
        "height": 29.7,
        "margins": {
          "right": 0.5,
          "bottom": 0.5
        },
        "components": [
          {}
        ]
      }
    ],
    "dataSettings": {
      "sortBy": [
        {}
      ],
      "filterBy": [
        {}
      ]
    },
    "editor": {
      "heightMultiplier": 2
    }
  },
  "meta": {}
}
```

#### Error Responses
- **401**: Unauthorized
- **402**: Account Suspended
- **403**: Forbidden
- **404**: Not Found
- **422**: Unprocessable Entity
- **429**: Too Many Requests
- **500**: Internal Server Error
```

--------------------------------

### Get Form

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves the configuration of a specific form using its unique identifier.

```APIDOC
## GET /forms/{formId}

### Description
Returns the configuration of a specific form.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/forms/{formId}

### Parameters
#### Path Parameters
- **formId** (integer) - Required - Form unique identifier.

### Responses
- **200** - Form configuration
- **401** - Unauthorized
- **402** - Account Suspended
- **403** - Forbidden
- **404** - Not Found
- **422** - Unprocessable Entity
- **429** - Too Many Requests
- **500** - Internal Server Error

### Response Example (200)
```json
{
  "response": {
    "id": 1,
    "template_id": 123123,
    "name": "Certificate creator",
    "actions": [
      {
        "store_document": true
      }
    ],
    "fields": [
      {
        "label": "Full name",
        "name": "name",
        "type": "text",
        "required": false
      }
    ],
    "configuration": {
      "title": "Employment application",
      "intro": "Please fill in all required fields.",
      "outro": "Thank you for your submission."
    }
  }
}
```
```

--------------------------------

### Async Document Generation Callback Response

Source: https://docs.pdfgeneratorapi.com/v4

This is an example of a response received at the callback URL when using asynchronous document generation. It provides a URL to the generated document.

```json
{
  "response": "https://us1.pdfgeneratorapi.com/share/12821/VBERi0xLjcKJeLjz9MKNyAwIG9i",
  "meta": {
    "name": "a2bd25b8921f3dc7a440fd7f427f90a4.pdf",
    "display_name": "a2bd25b8921f3dc7a440fd7f427f90a4",
    "encoding": "binary",
    "content-type": "application/pdf"
  }
}
```

--------------------------------

### Get templates

Source: https://docs.pdfgeneratorapi.com/v4

Returns a list of templates available for the authenticated workspace. Supports filtering by name, tags, and access level, with pagination.

```APIDOC
## GET /templates

### Description
Returns a list of templates available for the authenticated workspace. Supports filtering by name, tags, and access level, with pagination.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates

### Parameters
#### Query Parameters
- **name** (string) - Optional - Filter template by name.
- **tags** (string) - Optional - Filter template by tags.
- **access** (string) - Optional - Default: "" Enum: "private" "organization" "" Example: access=private. Filter template by access type. No values returns all templates. private - returns only private templates, organization - returns only organization templates.
- **page** (integer) - Optional - Default: 1 Example: page=1. Pagination: page to return.
- **per_page** (integer) - Optional - Default: 15 Example: per_page=20. Pagination: How many records to return per page.

### Request Example
```curl
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/templates?name=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&access=private&page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
An array of template objects with pagination metadata.
- **response** (Array of objects (Template)) - Description of the template objects.
- **meta** (object (paginationMeta)) - Information about pagination and navigation.

#### Response Example
```json
{
  "response": [
    {
      "id": 19375,
      "name": "Invoice template",
      "owner": true,
      "created_at": "2022-01-21 11:49:28",
      "updated_at": "2022-08-01 23:49:28",
      "tags": [
        "invoice",
        "orders"
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15
  }
}
```
```

--------------------------------

### GET /templates/{templateId}/versions

Source: https://docs.pdfgeneratorapi.com/v4

Returns a paginated list of template versions for the specified template.

```APIDOC
## GET /templates/{templateId}/versions

### Description
Returns a paginated list of template versions for the specified template.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates/{templateId}/versions

### Parameters
#### Path Parameters
- **templateId** (integer) - Required - Template unique identifier

#### Query Parameters
- **per_page** (integer) - Optional - Number of items per page.
- **page** (integer) - Optional - Page number to return.

### Request Example
```bash
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **response** (Array of objects (TemplateVersion)) - Paginated list of template versions.
- **meta** (object)

#### Response Example
```json
{
  "response": [
    {
      "id": 25,
      "template_id": 343123,
      "template_name": "withered-star-1234",
      "name": "plain-mouse-9765",
      "checksum": "ab12345940035a392019ca6386a037ae01234567",
      "user_id": 0,
      "user_name": 13243,
      "is_production": true,
      "created_at": "2025-11-13 14:38:02",
      "updated_at": "2025-11-13 14:38:05"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "last_page": 1
  }
}
```
```

--------------------------------

### Get Forms

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves a list of forms available for the organization, with pagination support.

```APIDOC
## GET /api/v4/forms

### Description
Returns a list of forms available for the organization. Supports pagination.

### Method
GET

### Endpoint
/api/v4/forms

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Default: 1 - The page number to retrieve.
- **per_page** (integer) - Optional - Default: 15 - The number of records to return per page.

### Request Example
```bash
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/forms?page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **response** (Array of FormConfiguration objects) - An array of form objects.
- **meta** (object) - Information about pagination and navigation.

#### Response Example
```json
{
  "response": [
    {
      "id": 1,
      "template_id": 123123,
      "name": "Certificate creator",
      "actions": [
        {
          "store_document": true
        }
      ],
      "fields": [
        {
          "label": "Full name",
          "name": "name",
          "type": "text",
          "required": false
        }
      ],
      "configuration": {
        "title": "Employment application",
        "intro": "Please fill in all required fields.",
        "outro": "Thank you for your submission."
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15
  }
}
```

#### Error Responses
- **401**: Unauthorized
- **402**: Account Suspended
- **403**: Forbidden
- **404**: Not Found
- **422**: Unprocessable Entity
- **429**: Too Many Requests
- **500**: Internal Server Error
```

--------------------------------

### Get Templates with Query Parameters (Shell + Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Use this snippet to retrieve a list of templates, filtering by name, tags, access level, and pagination. Ensure your Authorization header is correctly set.

```shell
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/templates?name=SOME_STRING_VALUE&tags=SOME_STRING_VALUE&access=private&page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Workspace

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves information for a specific workspace using its identifier. Requires JWT authentication.

```APIDOC
## GET /workspaces/{workspaceIdentifier}

### Description
Returns workspace information for the workspace identifier specified in the request.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/workspaces/{workspaceIdentifier}

### Path Parameters
- **workspaceIdentifier** (string) - Required - Example: demo.example@actualreports.com - Workspace identifier

### Response
#### Success Response (200)
- **response** (object (Workspace)) - Workspace information.

#### Response Example
```json
{
  "response": {
    "id": 1,
    "identifier": "demo.example@actualreports.com",
    "is_master_workspace": false,
    "created_at": "2020-04-01 12:03:12"
  }
}
```
```

--------------------------------

### Get Workspace by Identifier (Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Retrieve details for a specific workspace using its identifier. Include your Bearer token in the 'Authorization' header.

```curl
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/workspaces/demo.example@actualreports.com \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Curl GET Request to List Template Versions

Source: https://docs.pdfgeneratorapi.com/v4

Use this Curl command to retrieve a paginated list of template versions for a specific template. Ensure you replace 'REPLACE_BEARER_TOKEN' with your actual authentication token.

```bash
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Invoice Schema (Shell + Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Use this endpoint to retrieve the schema for generating invoices. Requires a Bearer token for authorization.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/einvoice/schema \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Documents

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves a list of generated documents created by the authorized workspace. This endpoint only returns documents generated using the output=url option.

```APIDOC
## GET /documents

### Description
Returns a list of generated documents created by authorized workspace and stored in PDF Generator API. If master user is specified as workspace in JWT then all documents created in the organization are returned. NB! This endpoint returns only documents generated using the output=url option.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/documents

### Parameters
#### Query Parameters
- **template_id** (integer) - Required - Template unique identifier
- **start_date** (string) - Optional - Start date. Format: Y-m-d H:i:s
- **end_date** (string) - Optional - End date. Format: Y-m-d H:i:s. Defaults to current timestamp
- **page** (integer) - Optional - Pagination: page to return. Defaults to 1
- **per_page** (integer) - Optional - Pagination: How many records to return per page. Defaults to 15

### Request Example
```curl
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/documents?template_id=19375&start_date=2022-08-01%2012%3A00%3A00&end_date=2022-08-05%2012%3A00%3A00&page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **response** (Array of objects (Document)) - A list of generated documents
- **meta** (object (paginationMeta)) - Information about pagination and navigation

#### Response Example
```json
{
  "response": [
    {
      "public_id": "a2bd25b8921f3dc7a440fd7f427f90a4",
      "public_url": "https://us1.pdfgeneratorapi.com/api/v4/documents/66/6475768884cecfcd3ed4e6028be8a580/share",
      "template_id": 18905762,
      "created_at": "2022-07-02 13:04:21",
      "expires_at": "2022-08-02 13:04:21"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15
  }
}
```
```

--------------------------------

### Get Template Schema (Shell + Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Use this cURL command to fetch the JSON schema that defines the structure of a template definition. Ensure you replace 'REPLACE_BEARER_TOKEN' with your actual authentication token.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/schema \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Forms List using cURL

Source: https://docs.pdfgeneratorapi.com/v4

Retrieve a list of forms available for your organization using this cURL command. You can specify pagination parameters like 'page' and 'per_page'.

```shell
curl --request GET \
  --url 'https://us1.pdfgeneratorapi.com/api/v4/forms?page=1&per_page=20' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Async Job Status with Curl

Source: https://docs.pdfgeneratorapi.com/v4

Example using cURL to retrieve the status of an asynchronous document generation job using its job ID.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/documents/async/968b8a3a-e8ac-49cc-a670-25db545813ed \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Template Version Promoted Successfully Response

Source: https://docs.pdfgeneratorapi.com/v4

A 200 OK response with this JSON body confirms that a template version has been successfully promoted to production.

```json
{
  "response": {
    "id": 25,
    "template_id": 343123,
    "template_name": "withered-star-1234",
    "name": "plain-mouse-9765",
    "checksum": "ab12345940035a392019ca6386a037ae01234567",
    "user_id": 0,
    "user_name": 13243,
    "is_production": true,
    "created_at": "2025-11-13 14:38:02",
    "updated_at": "2025-11-13 14:38:05"
}

}
```

--------------------------------

### Promote Template Version Request (Shell + Curl)

Source: https://docs.pdfgeneratorapi.com/v4

Use this cURL command to promote a template version to production. Only one version can be active as production at a time. Replace 'REPLACE_BEARER_TOKEN' with your valid token.

```shell
curl --request PUT \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions/%7BtemplateVersion%7D/promote \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get Document by Public ID using Curl

Source: https://docs.pdfgeneratorapi.com/v4

Retrieve a specific document from storage using its public ID. This requires a GET request and authorization via a Bearer token.

```shell
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/documents/bac8381bce1982e5f6957a0f52371336 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Curl GET Request to Get Template Version

Source: https://docs.pdfgeneratorapi.com/v4

This Curl command retrieves the definition of a specific template version. Replace '{templateVersion}' with the actual version ID and 'REPLACE_BEARER_TOKEN' with your token.

```bash
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions/%7BtemplateVersion%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Import Template

Source: https://docs.pdfgeneratorapi.com/v4

Creates a new template by importing an existing PDF file. The PDF can be provided via a URL or a base64 encoded string.

```APIDOC
## POST /templates/import

### Description
Creates a template from an existing PDF. The PDF can be imported via a URL or a base64 string.

### Method
POST

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates/import

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
##### Schema: application/json
```json
{
  "template": {
    "name": "string"
  },
  "file_url": "string"
}
```

### Request Example
```json
{
  "template": {
    "name": "Invoice template"
  },
  "file_url": "string"
}
```

### Response
#### Success Response (201)
Template configuration

#### Error Responses
- **401** Unauthorized
- **402** Account Suspended
- **403** Forbidden
- **404** Not Found
- **422** Unprocessable Entity
- **429** Too Many Requests
- **500** Internal Server Error
```

--------------------------------

### JSON Response for Editor

Source: https://docs.pdfgeneratorapi.com/v4

This is a sample JSON response when successfully opening the editor. It contains a URL to access the editor.

```json
{
  "response": "https://us1.pdfgeneratorapi.com/editor/open/2ff98760d39456c4b2cf974fef005ecf"
}
```

--------------------------------

### Get job status

Source: https://docs.pdfgeneratorapi.com/v4

Returns the status of an asynchronous job.

```APIDOC
## Get job status

### Description
Returns status of an async job.

### Method
GET

### Endpoint
/api/v4/documents/async/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - Job id.

### Response
#### Success Response (200)
Async job status.
- **job_id** (string) - UUID of the async job.
- **status** (string) - Status of the async job. Enum: "pending", "ready", "published", "error", "webhook_error".

#### Response Example
```json
{
  "job_id": "968b8a3a-e8ac-49cc-a670-25db545813ed",
  "status": "published"
}
```
```

--------------------------------

### Promote template version

Source: https://docs.pdfgeneratorapi.com/v4

Promotes a specified template version to production. Only one version can be in production at a time. Requires JSON Web Token authentication.

```APIDOC
## Promote template version 
Promotes the specified template version to production. Only one version can be production at a time.
### Method
PUT
### Endpoint
/api/v4/templates/{templateId}/versions/{templateVersion}/promote
### Parameters
#### Path Parameters
- **templateId** (integer) - Required - Template unique identifier
- **templateVersion** (integer) - Required - Unique ID of the template version.
### Responses
#### Success Response (200)
- Template version promoted successfully
##### Response Schema: application/json
- **response** (object) - (TemplateVersion)
  - **id** (integer)
  - **template_id** (integer)
  - **template_name** (string)
  - **name** (string)
  - **checksum** (string)
  - **user_id** (integer)
  - **user_name** (integer)
  - **is_production** (boolean)
  - **created_at** (string)
  - **updated_at** (string)
#### Error Responses
- **401** Unauthorized
- **403** Forbidden
- **404** Not Found
- **422** Unprocessable Entity
- **429** Too Many Requests
- **500** Internal Server Error
### Request Example
```curl
curl --request PUT \
  --url https://us1.pdfgeneratorapi.com/api/v4/templates/19375/versions/%7BtemplateVersion%7D/promote \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```
```

--------------------------------

### Open Form Builder using cURL

Source: https://docs.pdfgeneratorapi.com/v4

This cURL command shows how to open a new session for the Form Builder, returning an embeddable URL. Remember to replace 'REPLACE_BEARER_TOKEN' with your authentication token.

```shell
curl --request POST \
  --url https://us1.pdfgeneratorapi.com/api/v4/forms/open \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

--------------------------------

### Get schema

Source: https://docs.pdfgeneratorapi.com/v4

Returns the e-invoice JSON schema, defining the structure for e-invoice payloads.

```APIDOC
## Get schema 

### Description
Returns e-invoice JSON schema which defines the structure of the e-invoice.

### Method
GET

### Endpoint
/api/v4/einvoice/schema

### Responses
#### Success Response (200)
Template JSON Schema.

#### Response Schema
object
```

--------------------------------

### Get Document

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves a specific document from the Document Storage using its public ID.

```APIDOC
## GET /documents/{publicId}

### Description
Returns document stored in the Document Storage.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/documents/{publicId}

### Parameters
#### Path Parameters
- **publicId** (string) - Required - Resource public id

### Request Example
```curl
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/documents/bac8381bce1982e5f6957a0f52371336 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **response** (string) - Public URL to the document.
- **meta** (object) - Metadata about the document.

#### Response Example
```json
{
  "response": "https://us1.pdfgeneratorapi.com/api/v4/documents/66/bac8381bce1982e5f6957a0f52371336/share",
  "meta": {
    "name": "a2bd25b8921f3dc7a440fd7f427f90a4.pdf",
    "display_name": "a2bd25b8921f3dc7a440fd7f427f90a4",
    "encoding": "binary",
    "content-type": "application/pdf",
    "public_id": "bac8381bce1982e5f6957a0f52371336"
  }
}
```
```

--------------------------------

### Create Form

Source: https://docs.pdfgeneratorapi.com/v4

Creates a new form based on the provided configuration.

```APIDOC
## POST /api/v4/forms

### Description
Creates a new form based on the configuration sent in the request body.

### Method
POST

### Endpoint
/api/v4/forms

### Parameters
#### Request Body
- **template_id** (integer) - Required - Template ID which is connected to the form.
- **name** (string) - Required - Form name.
- **actions** (Array of objects) - Required - Array of action configurations (e.g., store_document, download, send).
- **fields** (Array of objects) - Required - A list of form field objects.
- **configuration** (object) - Optional - Display configuration shown around the form fields.

### Request Example
```json
{
  "template_id": 123123,
  "name": "Certificate creator",
  "actions": [
    {
      "store_document": true
    }
  ],
  "fields": [
    {
      "label": "Full name",
      "name": "name",
      "type": "text",
      "required": false
    }
  ],
  "configuration": {
    "title": "Employment application",
    "intro": "Please fill in all required fields.",
    "outro": "Thank you for your submission."
  }
}
```

### Response
#### Success Response (201)
- **response** (object) - The created form configuration.

#### Response Example
```json
{
  "response": {
    "id": 1,
    "template_id": 123123,
    "name": "Certificate creator",
    "actions": [
      {
        "store_document": true
      }
    ],
    "fields": [
      {
        "label": "Full name",
        "name": "name",
        "type": "text",
        "required": false
      }
    ],
    "configuration": {
      "title": "Employment application",
      "intro": "Please fill in all required fields.",
      "outro": "Thank you for your submission."
    }
  }
}
```

#### Error Responses
- **401**: Unauthorized
- **402**: Account Suspended
- **403**: Forbidden
- **404**: Not Found
- **422**: Unprocessable Entity
- **429**: Too Many Requests
- **500**: Internal Server Error
```

--------------------------------

### Response JSON Sample

Source: https://docs.pdfgeneratorapi.com/v4

This is a sample JSON response structure, likely from an API call that returns template information. It includes metadata and the template's configuration.

```json
{
  "response": {
    "id": 19375,
    "name": "Invoice template",
    "tags": [
      "invoice",
      "orders"
],
    "isDraft": true,
    "layout": {
      "format": "A4",
      "width": 21,
      "height": 29.7,
      "unit": "cm",
      "orientation": "portrait",
      "rotation": 0,
      "margins": {
        "top": 0.5,
        "right": 0.5,
        "bottom": 0.5,
        "left": 0.5
},
      "repeatLayout": {
        "format": "A4",
        "width": 21,
        "height": 29.7
},
      "emptyLabels": 0
},
    "pages": [
      {
        "width": 21,
        "height": 29.7,
        "margins": {
          "right": 0.5,
          "bottom": 0.5
},
        "components": [
          { }
]
}
],
    "dataSettings": {
      "sortBy": [
        { }
],
      "filterBy": [
        { }
]
},
    "editor": {
      "heightMultiplier": 2
}
},
  "meta": { }

}
```

--------------------------------

### Get Invoice Schema

Source: https://docs.pdfgeneratorapi.com/v4

Retrieves the schema for generating invoices. This endpoint is useful for understanding the required structure of invoice data.

```APIDOC
## GET /api/v4/einvoice/schema

### Description
Retrieves the schema for generating invoices.

### Method
GET

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/einvoice/schema

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl --request GET \
  --url https://us1.pdfgeneratorapi.com/api/v4/einvoice/schema \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
```

### Response
#### Success Response (200)
- **Content-Type**: application/json
- **Body**: An empty JSON object `{}` is returned on success, indicating the schema is available.
```

--------------------------------

### Import Form Configuration (JSON)

Source: https://docs.pdfgeneratorapi.com/v4

Use this JSON payload to import a new form. Specify either a file URL or base64 encoded data for the PDF. The 'form' object contains details like template ID, name, actions, fields, and configuration.

```json
{
  "file_url": "string",
  "form": {
    "template_id": 123123,
    "name": "Certificate creator",
    "actions": [
      {
        "store_document": true
}
],
    "fields": [
      {
        "label": "Full name",
        "name": "name",
        "type": "text",
        "required": false
}
],
    "configuration": {
      "title": "Employment application",
      "intro": "Please fill in all required fields.",
      "outro": "Thank you for your submission."
}
}

}
```

--------------------------------

### Create template

Source: https://docs.pdfgeneratorapi.com/v4

Creates a new template. If template configuration is not specified in the request body then an empty template is created. Template configuration must be sent in the request body.

```APIDOC
## POST /templates

### Description
Creates a new template. If template configuration is not specified in the request body then an empty template is created. Template configuration must be sent in the request body.

### Method
POST

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/templates

### Parameters
#### Request Body
- **name** (string) - Required - Template name.
- **tags** (Array of strings) - Optional - A list of tags assigned to a template.
- **isDraft** (boolean) - Optional - Indicates if the template is a draft or published.
- **layout** (object) - Optional - Defines template layout (e.g page format, margins).
- **pages** (Array of objects) - Optional - Defines page or label size, margins and components on page or label.
- **dataSettings** (object) - Optional - Defines filter and sort option for root data set.
- **editor** (object) - Optional - Configuration preferences for the editor.
- **fontSubsetting** (boolean) - Optional - Default: false. If font-subsetting is applied to document when generated.
- **barcodeAsImage** (boolean) - Optional - Default: false. Defines if barcodes are rendered as raster images instead of vector graphics.

### Responses
#### Success Response (201)
Template configuration.

#### Error Response (401, 402, 403, 404, 422, 429, 500)
See error codes in the documentation.
```

--------------------------------

### Async Document Generation Response

Source: https://docs.pdfgeneratorapi.com/v4

This is a sample response for an asynchronous document generation job. It contains the job ID required to track the generation status.

```json
{
  "response": {
    "job_id": "JeLjz9MKNyAwIG9iago8PCA"
}

}
```

--------------------------------

### Generate QR Code

Source: https://docs.pdfgeneratorapi.com/v4

Creates a QR code based on the provided configuration, including content, color, and an optional logo.

```APIDOC
## POST /assets/qrcode

### Description
Creates a QR code based on the configuration.

### Method
POST

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/assets/qrcode

### Parameters
#### Request Body
- **content** (string) - Required - The content which is used to generate QR code
- **color** (string) - Optional - Default: "#000000" - QR code in hexadecimal format
- **logo_base64** (string) - Optional - A logo as a base64 image string to add on the QR code
- **logo_url** (string) - Optional - A logo URL to an image to add on the QR code
- **output** (string) - Optional - Default: "base64" - Enum: "file" "base64" - Response format

### Request Example
```json
{
  "content": "My QR Code",
  "color": "#000000",
  "logo_base64": "string",
  "logo_url": "string",
  "output": "base64"
}
```

### Response
#### Success Response (201)
- **response** (string) - QR code data
- **meta** (object) - Metadata about the QR code
  - **encoding** (string) - Encoding type
  - **content-type** (string) - Content type of the QR code

#### Response Example
```json
{
  "response": "JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...",
  "meta": {
    "encoding": "base64",
    "content-type": "image/png"
  }
}
```
```

--------------------------------

### Add Watermark Response Payload

Source: https://docs.pdfgeneratorapi.com/v4

This is an example response for a successful watermark addition. It includes the processed PDF data (base64 encoded) and metadata.

```json
{
  "response": "JVBERi0xLjcKJeLjz9MKNyAwIG9iago8PCAvVHlwZSA...",
  "meta": {
    "name": "a2bd25b8921f3dc7a440fd7f427f90a4.pdf",
    "display_name": "a2bd25b8921f3dc7a440fd7f427f90a4",
    "encoding": "base64",
    "content-type": "application/pdf",
    "public_id": "a2bd25b8921f3dc7a440fd7f427f90a4"
}
}
```

--------------------------------

### Create Workspace

Source: https://docs.pdfgeneratorapi.com/v4

Creates a new workspace with a specified identifier. Requires JWT authentication.

```APIDOC
## POST /workspaces

### Description
Creates a regular workspace with the identifier specified in the request.

### Method
POST

### Endpoint
https://us1.pdfgeneratorapi.com/api/v4/workspaces

### Request Body
- **identifier** (string) - Required - A unique identifier of the workspace. Make sure that you can generate the same identifier for your user.

### Request Example
```json
{
  "identifier": "demo.example@actualreports.com"
}
```

### Response
#### Success Response (201)
- **response** (object (Workspace)) - Workspace information.

#### Response Example
```json
{
  "response": {
    "id": 1,
    "identifier": "demo.example@actualreports.com",
    "is_master_workspace": false,
    "created_at": "2020-04-01 12:03:12"
  }
}
```
```
Tokens:
Raw