Dashboard Getting Started

Start your first successful dashboard session

Use this guide when you are signed in and want the calmest path through the UI: create one key inAPI Keys, test one render in API Explorer, confirm what happened inRender jobs, and only then decide whether to move into Templates orBatches.

Recommended path

Start on Overview and open the first setup pages from the dashboard.
Create one key, then test one HTML render in API Explorer.
Use Render jobs to confirm the result before moving into reusable or batch workflows.

Start here when

You want UI guidance first instead of beginning with request-level API docs.

First success looks like

One key created, one render tested, and one result visible in Render jobs.

Use later

Move to Templates for reuse and Batches for many-document workflows.

Create your first key Open API Explorer Read API quickstart

Start Here

Begin with three pages and ignore the rest for a moment

The dashboard has more pages than a first-time user needs. These three pages are enough for a real first session.

Orientation first

Overview

Start on the workspace landing page, use the existing quick actions, and avoid jumping straight into monitoring views.

Workspace

First setup task

API Keys

Open Create key, generate one credential, and store the secret immediately because it is shown once.

Required

First test surface

API Explorer

Open HTML for the shortest first render path inside the dashboard.

First test

First Session Path

Follow this order for the shortest realistic first session

This sequence keeps the dashboard simple: one credential, one test render, one place to confirm the result, then a clear branch into reuse or scale.

Open Overview

Use Overview as the orientation point, not as a setup manual. It already points first-time users toward Create API key and API Explorer.

Create one key in API Keys

Use Create key under API Keys, name the credential, choose the mode you need, and store the one-time secret before leaving the page.

Test one render in API Explorer

Open API Explorer and stay on HTML for the first test so the workflow proves the render path with the least setup.

Check Render jobs

Open Render jobs after the test. It is the durable place to review queued, processing, completed, failed, and expired single-render work.

Choose the next workflow only after the first render works

Move to Templates when you want a reusable HTML starting point. Move to Batches when you need many PDFs in one request.

When To Use Each Page

Route yourself by task, not by curiosity

These are the next pages that matter once the first credential and first render path are clear.

Use next after Explorer

Render jobs

Reopen recent jobs, inspect what happened, jump into detail, replay work in Explorer, or download the PDF when it is ready.

Follow-up

Use when one-off renders feel repetitive

Templates

Create, edit, preview, and save reusable HTML so repeatable PDF generation starts from a stable template instead of a blank screen.

Reuse

Use when you need many PDFs at once

Batches

Start in Create batch for multi-item work, then move into Recent batches to monitor progress, inspect failures, and download completed output.

Scale

All keys

Use All keys after the first setup when you need inventory, rotation, revocation, or allowlist changes.

Request Logs, Usage, and Audit Logs

Use these when you are diagnosing failures, reviewing account activity, or checking traffic patterns.

Billing, Invoices, and Profile

Use these for plan, invoice, and account housekeeping work, not for the first successful render.

Come Back Later

You do not need most of the dashboard on day one

Treat these areas as later operating surfaces so the first session stays narrow and calm.

Monitoring later

Leave Request Logs, Usage, and Audit Logs until something needs investigation

These pages matter once you have traffic, failures, or account activity to review. They are not required to get the first key and first render working.

Account later

Leave Billing, Invoices, and Profile for account housekeeping

Use them when plan changes, invoices, exports, or profile details matter. Keep them out of the first dashboard session unless you are blocked by quota or subscription state.

Admin excluded

Ignore super-admin pages in the normal user path

The first-time dashboard journey should not depend on admin-only routes. Keep the main path inside the normal workspace pages.

Next Steps

Go deeper only after the first dashboard session works

Use the app for the first session, then use the docs below when you need the API contract, accepted-work behavior, or a request-level quickstart.

Opened the dashboard but need the API path too?

Read quickstart

Use the request-level quickstart for the fastest API-first render path with the same credential and success expectations.

Guide

Need to reason about queued work?

Read execution model

Understand why accepted work is still success and why Render jobs matters when a render does not finish inline.

Concept

Need the exact retrieval contract?

Read accepted jobs reference

Use the status and file-route reference once you are hardening polling, recovery, and download behavior.

Reference