{"id":4434,"date":"2026-03-16T20:05:26","date_gmt":"2026-03-16T18:05:26","guid":{"rendered":"https:\/\/fastpixel.io\/?page_id=4434"},"modified":"2026-03-19T09:33:06","modified_gmt":"2026-03-19T07:33:06","slug":"api","status":"publish","type":"page","link":"https:\/\/fastpixel.io\/fr\/api\/","title":{"rendered":"FastPixel API"},"content":{"rendered":"

FastPixel API<\/h1>\n\n\n\n

The FastPixel API lets you send a page URL together with optimization settings so the page can be processed by the optimizer.<\/p>\n\n\n\n

This request includes the target page URL, a postback URL for updates, and a settings<\/code> object that controls features such as script rewriting, image rewriting, reduced fonts, image quality, cropping, two-phase loading, and custom CSS.<\/p>\n\n\n\n

Endpoint<\/h2>\n\n\n\n

Method:<\/strong> POST<\/code><\/p>\n\n\n\n

API URL:<\/strong> https:\/\/api.fastpixel.io\/<\/code><\/a><\/p>\n\n\n\n

Endpoint:<\/strong> \/api\/v1\/enqueue<\/code><\/p>\n\n\n\n

Request Body<\/h2>\n\n\n\n

Send a JSON body like this:<\/p>\n\n\n\n

{
  \"url\": \"https:\/\/domain.com\/\",
  \"postbackUrl\": \"https:\/\/domain.com\/wp-json\/fastpixel-website-accelerator\/v1\/update\",
  \"settings\": {
    \"modules\": {
      \"ScriptRewrite\": {
        \"enabled\": true,
        \"settings\": {
          \"exclude\": {
            \"strings\": [],
            \"regexps\": []
          },
          \"eventHandlersRewrite\": false,
          \"rdelay\": 0,
          \"excludeGDPR\": true
        },
        \"injectBootstrapScripts\": true
      },
      \"ImageRewrite\": {
        \"enabled\": true,
        \"settings\": {
          \"forceImageDimensions\": false
        }
      },
      \"ReducedFonts\": {
        \"settings\": {
          \"soft\": true
        }
      }
    },
    \"imageQuality\": \"glossy\",
    \"cropImages\": true,
    \"customCSS\": \"\"
  },
  \"acceptEncoding\": \"gzip\",
  \"plugin_version\": \"1.2.3\",
  \"siteKey\": \"your-site-key\"
}<\/pre>\n\n\n\n
Request Parameters<\/h2>\n\n\n\n
Top-level parameters<\/h3>\n\n\n\n
Parameter<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>
url<\/code><\/td>string<\/td>Yes<\/td>The page URL to optimize.<\/td><\/tr>
postbackUrl<\/code><\/td>string<\/td>Yes<\/td>Callback URL used to send optimization updates back to the plugin or client.<\/td><\/tr>
settings<\/code><\/td>object<\/td>Yes<\/td>Main optimization settings object.<\/td><\/tr>
acceptEncoding<\/code><\/td>string<\/td>No<\/td>Accepted content encoding. Example: gzip<\/code>.<\/td><\/tr>
plugin_version<\/code><\/td>string<\/td>No<\/td>Version of the plugin or client sending the request.<\/td><\/tr>
siteKey<\/code><\/td>string<\/td>Yes<\/td>Site-specific authentication or identification key.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Settings Object<\/h2>\n\n\n\n
The settings<\/code> object contains general optimization options and module-specific configuration.<\/p>\n\n\n\n
General settings<\/h3>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
settings.imageQuality<\/code><\/td>string<\/td>Image optimization level. Supported values shown in the examples: lossless<\/code>, glossy<\/code>, lossy<\/code>. The images are optimized using the ShortPixel image optimization service. Learn more<\/a>.<\/td><\/tr>
settings.cropImages<\/code><\/td>boolean<\/td>Enables or disables image cropping. Image cropping ensures that images which are not fully visible (such as backgrounds) are cropped to include only the displayed portion, helping reduce file size and save storage space.<\/td><\/tr>
settings.customCSS<\/code><\/td>string<\/td>Custom CSS to include during processing. It will also be included in CriticalCSS. Can be empty.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Modules<\/h2>\n\n\n\n
The settings.modules<\/code> object groups together the feature-specific optimization modules.<\/p>\n\n\n\n
ScriptRewrite<\/h3>\n\n\n\n
Controls script rewriting behavior.<\/p>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
settings.modules.ScriptRewrite.enabled<\/code><\/td>boolean<\/td>Enables or disables JavaScript optimization. Set to False for no JS optimization or True to Optimize JS or Delay JS.<\/td><\/tr>
settings.modules.ScriptRewrite.settings.exclude.strings<\/code><\/td>array of strings<\/td>List of string-based exclusions.<\/td><\/tr>
settings.modules.ScriptRewrite.settings.exclude.regexps<\/code><\/td>array<\/td>List of regexp-based exclusions.<\/td><\/tr>
settings.modules.ScriptRewrite.settings.eventHandlersRewrite<\/code><\/td>boolean<\/td>Enables or disables event handler rewriting.<\/td><\/tr>
settings.modules.ScriptRewrite.settings.rdelay<\/code><\/td>number<\/td>Delay value used by script rewriting. Examples shown include 0<\/code> and 86400000<\/code>.<\/td><\/tr>
settings.modules.ScriptRewrite.settings.excludeGDPR<\/code><\/td>boolean<\/td>Enables exclusion behavior for GDPR-related scripts.<\/td><\/tr>
settings.modules.ScriptRewrite.injectBootstrapScripts<\/code><\/td>boolean<\/td>Enables bootstrap script injection.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example regexp exclusion:<\/p>\n\n\n\n
{
  \"type\": \"RegExp\",
  \"source\": \"RegExpExclusionMarc\",
  \"flags\": \"i\"
}<\/pre>\n\n\n\n
ImageRewrite<\/h3>\n\n\n\n
Controls image rewriting behavior.<\/p>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
settings.modules.ImageRewrite.enabled<\/code><\/td>boolean<\/td>Enables or disables image rewriting.<\/td><\/tr>
settings.modules.ImageRewrite.settings.forceImageDimensions<\/code><\/td>boolean<\/td>Forces image dimensions when enabled.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
ReducedFonts<\/h3>\n\n\n\n
Controls reduced font behavior.<\/p>\n\n\n\n
Parameter<\/th>Type<\/th>Description<\/th><\/tr><\/thead>
settings.modules.ReducedFonts.settings.soft<\/code><\/td>boolean<\/td>Improve compatibility by also loading the original font in cases where the optimized fonts display glitches.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Parameter Notes<\/h2>\n\n\n\n
Image quality values<\/h3>\n\n\n\n
The following values are shown in the examples:<\/p>\n\n\n\n
    \n
  • lossless<\/code><\/li>\n\n\n\n
  • glossy<\/code><\/li>\n\n\n\n
  • lossy<\/code><\/li>\n<\/ul>\n\n\n\n
    Crop images<\/h3>\n\n\n\n
    This setting accepts:<\/p>\n\n\n\n
      \n
    • true<\/code><\/li>\n\n\n\n
    • false<\/code><\/li>\n<\/ul>\n\n\n\n
      Force image dimensions<\/h3>\n\n\n\n
      This setting accepts:<\/p>\n\n\n\n
        \n
      • true<\/code><\/li>\n\n\n\n
      • false<\/code><\/li>\n<\/ul>\n\n\n\n
        Custom CSS<\/h3>\n\n\n\n
        You can send a CSS string in customCSS<\/code>.<\/p>\n\n\n\n
        Example:<\/p>\n\n\n\n
        \"customCSS\": \".css Custom css.. demo\"<\/pre>\n\n\n\n
        An empty string is also valid:<\/p>\n\n\n\n
        \"customCSS\": \"\"<\/pre>\n\n\n\n
        Integrations<\/h3>\n\n\n\n
        Integrations do not affect the request parameters.<\/p>\n\n\n\n
        Example Requests<\/h2>\n\n\n\n
        Example 1: Lossless optimization with script rewriting disabled<\/h3>\n\n\n\n
        {
          \"url\": \"https:\/\/domain.com\/\",
          \"postbackUrl\": \"https:\/\/domain.com\/wp-json\/fastpixel-website-accelerator\/v1\/update\",
          \"settings\": {
            \"modules\": {
              \"ScriptRewrite\": {
                \"enabled\": false,
                \"settings\": {
                  \"exclude\": {
                    \"strings\": [],
                    \"regexps\": []
                  },
                  \"eventHandlersRewrite\": false
                },
                \"injectBootstrapScripts\": true
              },
              \"ImageRewrite\": {
                \"enabled\": true,
                \"settings\": {
                  \"forceImageDimensions\": false
                }
              },
              \"ReducedFonts\": {
                \"settings\": {
                  \"soft\": true
                }
              }
            },
            \"imageQuality\": \"lossless\",
            \"cropImages\": false,
            \"customCSS\": \"\"
          },
          \"acceptEncoding\": \"gzip\",
          \"plugin_version\": \"1.2.3\",
          \"siteKey\": \"your-site-key\"
        }<\/pre>\n\n\n\n
        Example 2: Glossy optimization with script rewriting enabled<\/h3>\n\n\n\n
        {
          \"url\": \"https:\/\/domain.com\/sample-page\",
          \"postbackUrl\": \"https:\/\/domain.com\/wp-json\/fastpixel-website-accelerator\/v1\/update\",
          \"settings\": {
            \"modules\": {
              \"ScriptRewrite\": {
                \"enabled\": true,
                \"settings\": {
                  \"exclude\": {
                    \"strings\": [],
                    \"regexps\": []
                  },
                  \"eventHandlersRewrite\": false,
                  \"rdelay\": 0,
                  \"excludeGDPR\": true
                },
                \"injectBootstrapScripts\": true
              },
              \"ImageRewrite\": {
                \"enabled\": true,
                \"settings\": {
                  \"forceImageDimensions\": false
                }
              },
              \"ReducedFonts\": {
                \"settings\": {
                  \"soft\": true
                }
              }
            },
            \"imageQuality\": \"glossy\",
            \"cropImages\": true,
            \"customCSS\": \"\"
          },
          \"acceptEncoding\": \"gzip\",
          \"plugin_version\": \"1.2.3\",
          \"siteKey\": \"your-site-key\"
        }<\/pre>\n\n\n\n
        Example 3: Lossy optimization with delay and soft reduced fonts disabled<\/h3>\n\n\n\n
        {
          \"url\": \"https:\/\/domain.com\/\",
          \"postbackUrl\": \"https:\/\/domain.com\/wp-json\/fastpixel-website-accelerator\/v1\/update\",
          \"settings\": {
            \"modules\": {
              \"ScriptRewrite\": {
                \"enabled\": true,
                \"settings\": {
                  \"exclude\": {
                    \"strings\": [],
                    \"regexps\": []
                  },
                  \"eventHandlersRewrite\": false,
                  \"rdelay\": 86400000,
                  \"excludeGDPR\": true
                },
                \"injectBootstrapScripts\": true
              },
              \"ImageRewrite\": {
                \"enabled\": true,
                \"settings\": {
                  \"forceImageDimensions\": false
                }
              },
              \"ReducedFonts\": {
                \"settings\": {
                  \"soft\": false
                }
              }
            },
            \"imageQuality\": \"lossy\",
            \"cropImages\": true,
            \"customCSS\": \"\"
          },
          \"acceptEncoding\": \"gzip\",
          \"plugin_version\": \"1.2.3\",
          \"siteKey\": \"your-site-key\"
        }<\/pre>\n\n\n\n
        Response<\/h2>\n\n\n\n
        The examples show successful requests returning HTTP status 200<\/code>.<\/p>\n\n\n\n
        At the moment, the response body itself is not documented here because it is not included in the source material used for this page.<\/p>\n\n\n\n
        Notes<\/h2>\n\n\n\n
          \n
        • All examples use the \/api\/v1\/enqueue<\/code> endpoint.<\/li>\n\n\n\n
        • The request body is JSON.<\/li>\n\n\n\n
        • The settings<\/code> object is the main place where optimization behavior is configured.<\/li>\n\n\n\n
        • ScriptRewrite<\/code>, ImageRewrite<\/code>, and ReducedFonts<\/code> are the modules shown in the available examples.<\/li>\n\n\n\n
        • customCSS<\/code> can be empty or contain a CSS string.<\/li>\n\n\n\n
        • Integrations do not change the request parameter structure.<\/li>\n<\/ul>","protected":false},"excerpt":{"rendered":"
          FastPixel API The FastPixel API lets you send a page URL together with optimization settings so the page can be processed by the optimizer. This request includes the target page URL, a postback URL for updates, and a settings object that controls features such as script rewriting, image rewriting, reduced fonts, image quality, cropping, two-phase […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_uag_custom_page_level_css":"","footnotes":""},"class_list":["post-4434","page","type-page","status-publish","hentry"],"blocksy_meta":[],"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false,"trp-custom-language-flag":false,"betterdocs-category-thumb":false},"uagb_author_info":{"display_name":"Adrian","author_link":"https:\/\/fastpixel.io\/fr\/blog\/author\/adrian\/"},"uagb_comment_info":0,"uagb_excerpt":"FastPixel API The FastPixel API lets you send a page URL together with optimization settings so the page can be processed by the optimizer. This request includes the target page URL, a postback URL for updates, and a settings object that controls features such as script rewriting, image rewriting, reduced fonts, image quality, cropping, two-phase\u2026","_links":{"self":[{"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/pages\/4434","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/comments?post=4434"}],"version-history":[{"count":15,"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/pages\/4434\/revisions"}],"predecessor-version":[{"id":4455,"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/pages\/4434\/revisions\/4455"}],"wp:attachment":[{"href":"https:\/\/fastpixel.io\/fr\/wp-json\/wp\/v2\/media?parent=4434"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}