> For the complete documentation index, see [llms.txt](https://docs.santacruzsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.santacruzsoftware.com/printui/core-concepts/run-time-options-and-apis.md).

# Run-Time Options and APIs

## Run-time options

Run-time options are query parameters passed to the PrintUI web editor URL. The required launch parameters are the client and job ID. Additional options control editor appearance, available tools, galleries, previews, language, page behavior, text behavior, image behavior, and validation warnings.

The PrintUI editor is loaded from:

```
https://cdn.printui.com/editor/current/index.html
```

Run-time options follow `index.html` as URL query parameters.

## Completion events

When embedding the editor in an iframe, the parent page must listen for `postMessage` events. At minimum, implement the `printui_finished` handler so control returns to the host page when the user finishes.

If canceling is enabled, also handle `printui_cancel`. The Cancel button appears only when cancel text and alert behavior are configured.

## APIs

PrintUI APIs are used by host systems and developers to create jobs, request output, manage templates and fonts, resize jobs, impose documents, copy content, and retrieve completed files.

Common output APIs include PDF, JPEG, PNG, resize, and imposition requests. Exact API parameters depend on the endpoint and account configuration.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.santacruzsoftware.com/printui/core-concepts/run-time-options-and-apis.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.