Endpoints

List available fonts

Returns the hosted font catalog — every family is available on every plan — and the Google Fonts capability: any Google Fonts family can be used by passing a googleFontsUrl on POST /v1/render (up to googleFonts.maxFamiliesPerUrl families per URL). Use a hosted key as a fontStack entry; only weighted families can serve as the document body/heading family, and a family declared in googleFontsUrl / googleFontsUrls can also be referenced by name in rules (set.family). The guidance array carries the pairing/positional rules and the validate-first preflight tip; preflight a font choice with POST /v1/render/validate (a misspelled Google family returns 400 google_font_not_found without spending a render).

GET

fonts

curl --request GET \
  --url https://api.blinkpdf.io/v1/fonts \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.blinkpdf.io/v1/fonts"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.blinkpdf.io/v1/fonts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blinkpdf.io/v1/fonts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blinkpdf.io/v1/fonts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.blinkpdf.io/v1/fonts")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blinkpdf.io/v1/fonts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "hosted": [
    {
      "key": "<string>"
    }
  ],
  "googleFonts": {
    "maxFamiliesPerUrl": 2
  },
  "guidance": [
    "<string>"
  ]
}

{
  "error": "unauthorized"
}

{
  "error": "method_not_allowed"
}

{
  "error": "internal_error"
}

{
  "error": "service_unavailable",
  "detail": "Subscription tier lookup is temporarily unavailable. Retry the request."
}

Authorizations

x-api-key

string

header

required

API key issued from your Blink PDF account, prefixed bp_. Send it in the x-api-key header on every request. The documentation and health endpoints are exempt.

Response

The hosted catalog and the Google Fonts capability.

Fonts available to the authenticated caller: the hosted catalog (available on every plan) and the Google Fonts by-URL capability (googleFontsUrl on POST /v1/render, also available on every plan)

tier

enum<string>

required

Available options:

free,

pro,

business

hosted

object[]

required

Every hosted family in the catalog; all of them are available on every plan

Show child attributes

googleFonts

object

required

Show child attributes

guidance

string[]

required

Prose the flat catalog cannot convey: pairing/positional order, set.family references, and the validate-first preflight tip

Render a sandwich document

Describe style targets

List available fonts

curl --request GET \
  --url https://api.blinkpdf.io/v1/fonts \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.blinkpdf.io/v1/fonts"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.blinkpdf.io/v1/fonts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blinkpdf.io/v1/fonts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blinkpdf.io/v1/fonts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.blinkpdf.io/v1/fonts")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blinkpdf.io/v1/fonts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "hosted": [
    {
      "key": "<string>"
    }
  ],
  "googleFonts": {
    "maxFamiliesPerUrl": 2
  },
  "guidance": [
    "<string>"
  ]
}

{
  "error": "unauthorized"
}

{
  "error": "method_not_allowed"
}

{
  "error": "internal_error"
}

{
  "error": "service_unavailable",
  "detail": "Subscription tier lookup is temporarily unavailable. Retry the request."
}