Export Form as PDF

POST

https://api.coperniq.io/v1/forms/:form_id/pdf

Export a form to PDF. All body fields are optional.

x-api-keystring

API Key authentication via header

form_idintegerRequired

Form identifier

This endpoint expects an object.

imagesOnlybooleanOptional

Export only the form's image fields, omitting other field types. Defaults to false.

imagesInRowenumOptional

Number of images to lay out per row. Defaults to 2.

includeImageMetadatabooleanOptional

Include image metadata (e.g. GPS, timestamp) below each image. Defaults to true.

PDF generated successfully

pdfBase64string

Base64-encoded PDF bytes

contentTypeenum

namestring or nullOptional

Suggested file name for the exported PDF

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.coperniq.io/v1/forms/1/pdf';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}