Skip to content
JamFrame
Docs menu

Key terms

The words JamFrame uses, in plain English, from template and dynamic field to render credit, workspace and organization.

Designs

  • Template: A design you make in the editor and use again and again. The app lists your templates on the Templates page. The API calls them designs, and a template’s id is its templateId.
  • Page: A template can have up to 20 pages. Each page becomes one image, or one page of a PDF. A template with several pages is a carousel.
  • Layer: One thing on a page: a text box, an image, a shape or a QR code. The Layers panel lists them.
  • Dynamic field: A layer whose content you can change when you render. You turn it on with Let the render API change this layer and give it a Key. See Choose what changes.
  • Key: The name of a dynamic field, such as headline or photo. You use it to send a new value.
  • Variable: A key written inside text with double curly brackets, such as Hello {{name}}!. JamFrame fills in the value when it renders. The app’s API parameters list shows it as Placeholder, and the API gives it the type variable.
  • Ready-made template: A finished design from JamFrame that you can copy and change. The app shows them under Ready-made templates and Explore templates. The API calls them library templates. See Copy an existing template.
  • Saved fallback: The text or picture an AI layer has in the editor. Renders use it where AI doesn’t run, such as on dynamic URLs and forms. See AI layers.
  • Brand library: The place for your logos, photos, colors and fonts, shared by the whole workspace. See Brand library.

Making files

  • Render: Making a finished file from a template. Every render shows up on the Renders page.
  • Modifications: The values you send with a render, written as keys and values, like {"headline": "Summer sale"}.
  • Test render: A render you start from the editor, to check a template. It uses credits like any other render.
  • Dynamic URL: A link that makes an image from a template. Change the words in the link, and the image changes. See Dynamic URLs.
  • Signed URL: A link your code makes with the API for one fixed set of values. It makes the image when someone opens it, and nobody can change its values. See Signed URLs.
  • Form: A public page made from a template. Anyone with the link can fill it in and download the file. See Forms.
  • Workflow: Steps that make files for you, for example “every Monday, take the new rows of this sheet and render a post for each row”. See Workflows.
  • Smart Resize: Making the same template in other sizes, such as a story or a banner, without designing it again. See Smart Resize.

Credits

  • Render credit: What a render costs. One image, or one PDF page, is one credit. Failed renders are free.
  • AI credit: What AI features cost, such as designing with AI or writing text at render time. AI credits are separate from render credits. See Credits.

Account

  • Organization: Your company or team in JamFrame. It has one plan and one bill. Each person belongs to one organization.
  • Workspace: A space inside an organization with its own templates, brand library, renders, API keys and webhooks. An agency might use one workspace per client. See Organizations and workspaces.
  • API key: A secret that lets your code render in one workspace. See API keys.

Last updated

Still stuck?

Email [email protected] and a real person will reply. Tell us the template you were using and what you expected to happen.