Skip to content
Bloqr AI Bloqr AI

Vendor Quickstart

Switch to normal mode

This guide is for technical vendors integrating Bloqr-compiled lists into their products.

  1. Get an API key from app.bloqr.dev.
  2. Make your first compile request.
  3. Point your product at the compiled list URL or integrate the streaming endpoint.

First request examples

Terminal window
curl -X POST 'https://api.bloqr.dev/api/v1/compile' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "urls": ["https://easylist.to/easylist/easylist.txt"],
    "transformations": ["RemoveComments", "Deduplicate"]
  }'
const response = await fetch('https://api.bloqr.dev/api/v1/compile', {
    method: 'POST',
    headers: {
        'Authorization': `Bearer ${process.env.BLOQR_API_KEY}`,
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        urls: ['https://easylist.to/easylist/easylist.txt'],
        transformations: ['RemoveComments', 'Deduplicate'],
    }),
});


const payload = await response.json();
console.log(payload);

Key endpoint map

EndpointDescription
POST /api/v1/compileCompile a single configuration and return compiled output metadata.
POST /api/v1/compile/batchCompile multiple configurations in one request for bulk workflows.
GET /api/v1/compile/streamSubscribe to live compile progress and result events.
POST /api/v1/validateValidate requests before running production compiles.

Continue reading