C# SDK & REST Examples — TemplateFox

Two ways to use the TemplateFox API from .NET:

SDK (TemplateFox.SDK) — typed client auto-generated from our OpenAPI spec. Recommended.
REST — HttpClient. Useful for minimal dependencies.

Every example on this page shows both side-by-side.

Installation

dotnet add package TemplateFox.SDK
# or Package Manager:
Install-Package TemplateFox.SDK

The REST variant uses System.Net.Http (part of .NET).

Configuration

Set your API key once and reuse the client.

using TemplateFox.SDK.Api;
using TemplateFox.SDK.Client;

var config = new Configuration
{
  ApiKey = new Dictionary<string, string>
  {
      { "x-api-key", Environment.GetEnvironmentVariable("TEMPLATEFOX_API_KEY")! }
  }
};

var api = new PDFApi(config);

using System.Net.Http;
using System.Net.Http.Json;

const string BASE_URL = "https://api.templatefox.com";

var client = new HttpClient { BaseAddress = new Uri(BASE_URL) };
client.DefaultRequestHeaders.Add(
  "x-api-key",
  Environment.GetEnvironmentVariable("TEMPLATEFOX_API_KEY")
);

Generate a PDF

The minimum required fields are template_id and data. Everything else has a sensible default.

using TemplateFox.SDK.Model;

var request = new CreatePdfRequest(
  templateId: "YOUR_TEMPLATE_ID",
  data: new Dictionary<string, object>
  {
      { "customer_name",  "John Doe" },
      { "invoice_number", "INV-001" },
      { "amount",         "$1,234.56" }
  }
);

var response = await api.CreatePdfAsync(request);

Console.WriteLine(response.Url);               // signed URL valid 24h
Console.WriteLine(response.CreditsRemaining);  // credits left on the team

var response = await client.PostAsJsonAsync("/v1/pdf/create", new
{
  template_id = "YOUR_TEMPLATE_ID",
  data = new
  {
      customer_name  = "John Doe",
      invoice_number = "INV-001",
      amount         = "$1,234.56"
  }
});

var result = await response.Content.ReadFromJsonAsync<Dictionary<string, object>>();
Console.WriteLine(result!["url"]);

See Create PDF for every supported parameter.

Save the PDF to a file

using var httpClient = new HttpClient();

var response = await api.CreatePdfAsync(request);

var pdfBytes = await httpClient.GetByteArrayAsync(response.Url);
await File.WriteAllBytesAsync("invoice.pdf", pdfBytes);

var response = await client.PostAsJsonAsync("/v1/pdf/create", new
{
  template_id = "YOUR_TEMPLATE_ID",
  data = new { customer_name = "Jane Doe" },
  export_type = "binary"   // PDF bytes returned directly
});

await using var file = File.Create("invoice.pdf");
await response.Content.CopyToAsync(file);

Upload straight to your S3 bucket

Configure your S3 integration once in the dashboard, then pass StoreS3 = true on any call.

using TemplateFox.SDK.Model;

var request = new CreatePdfRequest(
  templateId: "YOUR_TEMPLATE_ID",
  data: new Dictionary<string, object> { { "invoice_number", "INV-001" } },
  filename:   "invoice-001",            // no extension, .pdf appended
  storeS3:    true,                      // upload to your configured bucket
  s3Filepath: "invoices/2026/04/"       // key prefix (optional)
  // s3Bucket: "custom-bucket"          // override bucket from integration
);

var response = await api.CreatePdfAsync(request);
Console.WriteLine($"{response.S3Bucket}/{response.S3Key}");

var response = await client.PostAsJsonAsync("/v1/pdf/create", new
{
  template_id = "YOUR_TEMPLATE_ID",
  data        = new { invoice_number = "INV-001" },
  filename    = "invoice-001",           // no extension
  store_s3    = true,                     // upload to your configured bucket
  s3_filepath = "invoices/2026/04/"      // key prefix (optional)
  // s3_bucket = "custom-bucket"         // override bucket
});

var result = await response.Content.ReadFromJsonAsync<Dictionary<string, object>>();
Console.WriteLine($"{result!["s3_bucket"]}/{result["s3_key"]}");

PDF/A compliance

For archival/legal use-cases, request a PDF/A variant.

using TemplateFox.SDK.Model;

var request = new CreatePdfRequest(
  templateId: "YOUR_TEMPLATE_ID",
  data:       new Dictionary<string, object> { { "customer_name", "John Doe" } },
  pdfVariant: "pdf/a-2b"   // "pdf/a-1b" | "pdf/a-2b" | "pdf/a-3b"
);

var response = await api.CreatePdfAsync(request);

var response = await client.PostAsJsonAsync("/v1/pdf/create", new
{
  template_id = "YOUR_TEMPLATE_ID",
  data        = new { customer_name = "John Doe" },
  pdf_variant = "pdf/a-2b"   // "pdf/a-1b" | "pdf/a-2b" | "pdf/a-3b"
});

Async generation with webhooks

For large documents or batch jobs, use the async endpoint. The .NET SDK exposes CreatePdfAsyncJobAsync, GetPdfJobAsync, and ListPdfJobsAsync — see Create PDF (Async) for the full flow.

using TemplateFox.SDK.Model;

var request = new CreatePdfAsyncRequest(
  templateId:    "YOUR_TEMPLATE_ID",
  data:          new Dictionary<string, object> { { "invoice_number", "INV-001" } },
  webhookUrl:    "https://example.com/webhooks/pdf",
  webhookSecret: "whk_a1b2c3d4e5f6g7h8i9j0k1l2"   // HMAC-SHA256 signing
);

var response = await api.CreatePdfAsyncJobAsync(request);
Console.WriteLine(response.JobId);
// Poll await api.GetPdfJobAsync(jobId) or wait for the webhook.

var response = await client.PostAsJsonAsync("/v1/pdf/create-async", new
{
  template_id    = "YOUR_TEMPLATE_ID",
  data           = new { invoice_number = "INV-001" },
  webhook_url    = "https://example.com/webhooks/pdf",
  webhook_secret = "whk_a1b2c3d4e5f6g7h8i9j0k1l2"   // HMAC-SHA256 signing
});

var result = await response.Content.ReadFromJsonAsync<Dictionary<string, object>>();
Console.WriteLine(result!["job_id"]);
// Poll GET /v1/pdf/jobs/{job_id} or wait for the webhook.

Error handling

using TemplateFox.SDK.Client;

try
{
  var response = await api.CreatePdfAsync(request);
}
catch (ApiException e)
{
  Console.WriteLine($"status={e.ErrorCode} body={e.ErrorContent}");
}

var response = await client.PostAsJsonAsync("/v1/pdf/create", new
{
  template_id = "INVALID_ID",
  data = new { }
});

if (!response.IsSuccessStatusCode)
{
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine($"status={(int)response.StatusCode} body={body}");
}

See Error codes for the full list.

Available SDK methods

Class	Method	Endpoint
`PDFApi`	`CreatePdfAsync`	`POST /v1/pdf/create`
`PDFApi`	`CreatePdfAsyncJobAsync`	`POST /v1/pdf/create-async`
`PDFApi`	`GetPdfJobAsync`	`GET /v1/pdf/jobs/{id}`
`PDFApi`	`ListPdfJobsAsync`	`GET /v1/pdf/jobs`
`TemplatesApi`	`ListTemplatesAsync`	`GET /v1/templates`
`TemplatesApi`	`GetTemplateFieldsAsync`	`GET /v1/templates/{id}/fields`
`AccountApi`	`GetAccountAsync`	`GET /v1/account`
`AccountApi`	`ListTransactionsAsync`	`GET /v1/account/transactions`
`IntegrationsApi`	`SaveS3ConfigAsync`	`POST /v1/integrations/s3`
`IntegrationsApi`	`GetS3ConfigAsync`	`GET /v1/integrations/s3`
`IntegrationsApi`	`DeleteS3ConfigAsync`	`DELETE /v1/integrations/s3`
`IntegrationsApi`	`TestS3ConnectionAsync`	`POST /v1/integrations/s3/test`

All REST endpoints are documented in the API Reference.

Next steps

Create PDF — every parameter in detail
Create PDF Async — webhooks + polling
GitHub repository — source, changelog, issues
Postman collection — test endpoints interactively