PAPIER DOCUMENTATION
Your code.
Every detail, connected.
Follow a practical guide, explore the SDK, or look up a command. The API reference is generated directly from Papier’s TypeScript source.
BUILD SOMETHING REAL
From first render to first send.
Send your first email
Publish a template, generate your client, test in the virtual inbox, and send through your provider.
Follow the guide 02Render a template
Turn a published email template into personalized HTML, save a preview, and use your existing delivery stack.
Follow the guide 03Configure email providers
Connect Resend or SendGrid with a typed adapter, configure a sender, and route messages between providers.
Follow the guideMeet your client.
Explore the factory, template methods, and configuration types.
26 SDK exports FROM YOUR TERMINALMake the connection.
Connect your project and generate a client from your template schemas.
4 CLI commandsTHE REFERENCE
Find your next step.
Guides
Step by stepPublish a template, generate your client, test in the virtual inbox, and send through your provider.
GuideRender a templateTurn a published email template into personalized HTML, save a preview, and use your existing delivery stack.
GuideConfigure email providersConnect Resend or SendGrid with a typed adapter, configure a sender, and route messages between providers.
GuideSDK reference
TypeScriptSurface types for type-safe template interactions.
InterfaceBuiltNotificationPayloadInterfaceBuiltPayloadType aliasBuiltSmsPayloadInterfacecreatePapierCreate a type-safe Papier client for your project.
FunctioncreatePapierClientFactory function to create a type-safe Papier client.
FunctionDocumentSurfaceExtract document templates from a project's templates.
Type aliasDocumentTemplateMethodsDocument surface methods for a specific template.
InterfaceEmailAdapterType aliasEmailConfigInterfaceEmailRoutingCallbackType aliasEmailSurfaceExtract email templates from a project's templates.
Type aliasEmailTemplateMethodsEmail surface methods for a specific template.
InterfaceNotificationSurfaceExtract notification templates from a project's templates.
Type aliasNotificationTemplateMethodsNotification surface methods for a specific template.
InterfacePapierGeneric Papier client with type-safe surfaces.
ClassPapierOptionsInterfaceProjectTemplatesType aliasSMSAdapterType aliasSMSConfigInterfaceSMSRoutingCallbackType aliasSmsSurfaceExtract SMS templates from a project's templates.
Type aliasSmsTemplateMethodsSMS surface methods for a specific template.
InterfaceTemplateDefinitionInterfacevirtualInboxAdapterConstantCLI commands
TerminalSupporting types
Type definitionsNo matching documentation.
Try “sending emails”, a provider like “Resend”, or a method like “renderHTML”.
d65ea8f71fbf