Getting Started

Prepare for your first successful PDF request

Use this hub to set up one render credential, understand how rendering auth differs from account auth, and plan for both valid success outcomes: output now or accepted work to follow.

Recommended path

Confirm required credentials and request assumptions.
Send one minimal request in quickstart.
Handle both success outcomes: immediate completion and accepted work.

Start here when

You want the shortest path from setup to a working integration call.

Required credential

One render key sent in the render API key header.

Success looks like

Either immediate output, or accepted work with a job ID for later retrieval.

Start quickstart Use dashboard guide Review auth models

Before You Start

Confirm these prerequisites before the first request

This checklist keeps the first call focused on integration behavior instead of setup mistakes.

Required credentials: one render API key

Create or reveal a render key from the dashboard, then pass it on every render request.

Auth expectation: API key, not bearer token

Single render and batch routes use the render API key header. Signed in account routes use hybrid bearer auth with an in memory access token and an httpOnly refresh cookie.

Execution expectation: two success outcomes

First calls may return output now or accepted work that continues through job status and file routes.

Auth And Execution

Learn these two concepts before deeper integration

These pages explain most first time integration confusion and keep route level docs easier to read.

Auth concept

Rendering uses API keys; account routes use hybrid bearer auth

Choose credentials by route family. Render create, status, and file flows are machine authenticated; user and account management flows are user authenticated with an in memory access token plus refresh cookie rotation.

Read auth models

Execution concept

Sync and async are both normal outcomes in rendering

An accepted response is still success. Design your client to handle both completed now and accepted outcomes from the start.

Read execution model

Pick Your First Task

Choose the next page by what you need right now

Start with quickstart for the first request. Use concept and reference pages as your immediate integration task changes.

Using the signed-in app first?

Start in the dashboard

Follow the UI-first path through Overview, API Keys, API Explorer, and Render jobs before moving into templates or batches.

Guide

Recommended first move

Make your first PDF request

Send one minimal HTML render request and validate success correctly for both immediate and accepted outcomes.

POST/v1/pdf

Quickstart

Need the lifecycle model first?

Review execution semantics

Understand when render work is completed inline vs accepted for later retrieval before building retries and polling.

Concept

Need exact contract details?

Open single render reference

Use route level request and response fields once your first request path is working and you are expanding behavior.

Reference