Documentation

API keys

An API key is a long, secret password that lets an automated script or another program use PixellPeep without logging in through the website. You only need one if you plan to run comparisons automatically (for example from your build system). This is an Enterprise feature, and is usually set up with a developer.

Open API keys settings

Configure

  1. 1

    Check your plan includes API keys

    API keys are part of the Enterprise plan. If the settings page shows an upgrade message instead of a "Create" button, your plan does not include them yet — contact us to upgrade.

    View plans
  2. 2

    Create a key

    On the API keys settings page, create and immediately copy your key:

    1. 1.Click "Create New API Key".
    2. 2.Give it a clear name describing where it will be used, e.g. "Nightly automated tests".
    3. 3.Click create.
    4. 4.Copy the key right away — for security it is shown only once and cannot be retrieved later.
    Open API keys settings
  3. 3

    Store it safely

    Paste the key into a secure place such as your automation tool's "secrets" or "environment variables" section. Never put it in a normal document, email, chat message, or your project files.

Test

  1. 1

    Use the key to run a comparison (developer step)

    Your developer sends a request to PixellPeep with the key in a header named "X-API-Key", attaching a baseline and a comparison image. A correct key returns the comparison result. Ready-made examples are on the API and CI pages below.

    See API examples
  2. 2

    Confirm the key is required

    Sending the same request without the key should be refused ("unauthorized"). That proves the key is genuinely protecting access.

  3. 3

    Revoke it if it ever leaks

    If a key is shared by accident or no longer needed, click "Revoke" or "Delete" on the settings page. It stops working instantly, so you can safely create a fresh one.

Tips

  • Treat an API key exactly like a password — anyone who has it can act as you.
  • Create a separate key per tool or person, so you can revoke one without affecting the others.
  • Prefer the header method over putting the key in a web address, since addresses can show up in logs.