Quick start

This page walks through your first render, from key to PDF bytes. It uses the welcome template of the getting-started project, which every organization gets published into its sandbox environment when the organization is created, so it needs no project setup.

API keys and environments

An API key looks like pp_{env}_…, and the environment name in the key decides where the render goes. pp_sandbox_… renders in the sandbox: documents carry a watermark, do not count toward your quota, and expire 30 days after creation. pp_live_… and the keys of environments you create on a Pro plan (pp_{name}_…) render without a watermark and count toward your quota. Every key targets the same API host.

Set your API key

Create a sandbox key in the dashboard and export it into the environment your program runs in:

export POLI_PAGE_API_KEY=pp_sandbox_x # replace with your key

Render a PDF

package main

import (
  "context"
  "os"

  "github.com/poli-page/sdk-go"
  "github.com/poli-page/sdk-go/option"
)

func main() {
  client := polipage.NewClient(
    option.WithAPIKey(os.Getenv("POLI_PAGE_API_KEY")),
  )

  pdf, err := client.Render.PDF(context.Background(), polipage.RenderInput{
    Project:  "getting-started",
    Template: "welcome",
    Data:     map[string]any{"name": "SDK Demo"},
  })
  if err != nil {
    panic(err)
  }
  _ = pdf // []byte — write to disk, return from a handler, upload to object storage.
}

pdf is a []byte. Write it to disk, stream it to S3, or return it directly from an HTTP handler. There is no version to pass: the render uses the project’s copy published in the key’s environment.

getting-started is a normal, editable project. If your organization renamed it, deleted it or removed it from sandbox, the API answers 404 PROJECT_NOT_FOUND or 404 PROJECT_NOT_IN_ENVIRONMENT; use a fresh organization. For your own templates, publish the project to the key’s environment and swap the slugs. To try a template or raw HTML without an API key, use the playground at play.poli.page.

Example

package main

import (
  "context"
  "os"

  "github.com/poli-page/sdk-go"
  "github.com/poli-page/sdk-go/option"
)

func main() {
  client := polipage.NewClient(
    option.WithAPIKey(os.Getenv("POLI_PAGE_API_KEY")),
  )

  if err := polipage.RenderToFile(
    context.Background(),
    client,
    polipage.RenderInput{
      Project:  "getting-started",
      Template: "welcome",
      Data:     map[string]any{"name": "SDK Demo"},
    },
    "./out/welcome.pdf",
  ); err != nil {
    panic(err)
  }
}

See also

• Authentication
• Render input
• Output handling