Upload Font

Overview#

This endpoint allows you to upload custom fonts to your workspace. You can upload font files from a URL, as a base64-encoded string, or as a binary upload. Uploaded fonts become available for use in your templates.

https://api.orshot.com/v1/brand-assets/fonts/add

Request#

await fetch("https://api.orshot.com/v1/brand-assets/fonts/add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    file: "https://example.com/fonts/BrandFont-Bold.ttf",
    name: "BrandFont-Bold.ttf", // optional
    tags: ["heading", "brand"], // optional
  }),
});

const formData = new FormData();
formData.append("file", fontFile); // File object
formData.append("name", "BrandFont-Bold.ttf"); // optional

await fetch("https://api.orshot.com/v1/brand-assets/fonts/add", {
method: "POST",
headers: {
Authorization: "Bearer <ORSHOT_API_KEY>",
},
body: formData,
});

{
  "data": {
    "font": {
      "id": 457,
      "created_at": "2025-09-11T10:15:30.123Z",
      "font_family": "BrandFont Bold",
      "file_name": "BrandFont-Bold.ttf",
      "file_url": "https://storage.orshot.com/custom-fonts/workspace_id/BrandFont-Bold.ttf",
      "file_size": 184320,
      "file_type": "font/ttf",
      "tags": [],
      "workspace_id": 50,
      "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
    },
    "url": "https://storage.orshot.com/custom-fonts/workspace_id/BrandFont-Bold.ttf"
  }
}

Request Parameters#

Supported Font Formats#

• TrueType (.ttf)
• OpenType (.otf)
• Web Open Font Format (.woff)
• Web Open Font Format 2 (.woff2)

Notes#

• Maximum file size: 10MB
• Uploaded fonts are immediately available for use in templates
• The font cache is automatically invalidated when a new font is uploaded

Error responses#

Input problems return 400 with a plain-language error and, for the two cases agents hit most, a stable code:

• FONT_NOT_A_FONT: the bytes carry no TTF, OTF, WOFF or WOFF2 signature. Usually a filename, a description, or placeholder text was sent instead of the file, or a URL served an HTML page.
• FONT_DATA_INCOMPLETE: the data starts as a real font file but ends early. The base64 was cut off in transit, the URL served a partial file, or the upload stopped before the end. The error names the fix for how the file was sent.

Hosted chat clients such as ChatGPT and Claude.ai cannot send file bytes, so a base64 file from them is almost always cut off. Pass a publicly reachable font URL instead.

Query Parameters#

Per-User Libraries#

Pass embedId and embedUserId together to add the font to that embed user's private library instead of the shared workspace library. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

• 30 requests per minute per endpoint