academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Documents → Generate and download a course document PDF

AI-generated

Summary

Generate and download a course document PDF using the supplied document data and academyFIVE API credentials. The operation returns the PDF as binary output alongside filename, MIME type, response headers, and status code metadata.

Inputs

  • data.type (required) — Document data type sent in the request body.
  • data.id (required) — Document identifier sent in the request body.
  • data.attributes.courseId (required) — Course ID for the document.
  • data.attributes.customProperties — JSON custom property values; if omitted or empty, the API uses default values.

Output shape

One binary PDF item per input item, with binary data in the data property and a JSON metadata object.

The JSON metadata includes mimeType, fileName, response headers, and statusCode. The filename is taken from the response Content-Disposition header when available, otherwise from the request URL, then defaults to data. With Continue On Fail enabled, errors are returned as JSON error items.

Examples

Example 1: Use the course-specific defaults

Provide the required document type, ID, and course ID; leave customProperties empty.

Example 2: Supply custom document values

Provide the required fields and customProperties as JSON.

Links

Discussion