Quickstart
Get Bloqr AI up and running quickly with your first protection policy and deployment path. This page helps new users validate the product in minutes.
Overview
Bloqr Systems helps you add a first protection policy, connect a deployment path, and verify that filtering is working end to end. This starter kit keeps the process simple so you can validate the product in minutes and customize the flow later for your own environment.
Before you begin, make sure you have an account, a project or workspace ready, and access to the place where you will deploy your policy.
Create an account
Set up your workspace and get your first project ready.
Add a policy
Define a basic protection rule for your first test.
Choose a deployment path
Connect Bloqr to your app, gateway, or service.
Verify protection
Confirm that requests are evaluated and blocked as expected.
Setup your account
Start by creating or opening your Bloqr AI workspace. Use a dedicated project for testing so you can safely experiment with policy changes without affecting production traffic.
Create your workspace
Sign in to Bloqr Systems and create a new project for this quickstart. Use a clear name such as quickstart-demo so you can find it later.
Generate credentials
Create the access token or API key your deployment will use. Store it in a secure environment variable and avoid committing it to source control.
Open the dashboard
Confirm that your project appears in the dashboard and that you can access policy, logs, and deployment settings.
Create your first policy
A first policy should be small and easy to understand. Start with one rule that blocks a clearly defined pattern, then expand it after you validate the full flow.
{
"name": "quickstart-protection",
"mode": "enforce",
"rules": [
{
"id": "block-sensitive-prompts",
"match": "contains_sensitive_data",
"action": "block"
}
]
}
const policy = {
name: "quickstart-protection",
mode: "enforce",
rules: [
{
id: "block-sensitive-prompts",
match: "contains_sensitive_data",
action: "block"
}
]
};
export default policy;
curl -X POST "https://api.example.com/v1/policies" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "quickstart-protection",
"mode": "enforce",
"rules": [
{
"id": "block-sensitive-prompts",
"match": "contains_sensitive_data",
"action": "block"
}
]
}'
Keep your first rule simple. If you can explain it in one sentence, you will find it easier to test and tune.
Deploy your policy
Bloqr AI can fit different deployment paths. Choose the one that matches your current architecture, then point it at the policy you created.
Use the API if your application already sends requests through a backend service.
export BLOQR_API_TOKEN="YOUR_API_TOKEN"
export BLOQR_POLICY_ID="policy_12345"
Use a gateway when you want centralized enforcement for multiple services. Connect the gateway to your project and attach the policy.
Use an SDK when you want the fastest integration in an application or worker process. Initialize the client with your token and policy reference.
Example deployment request
The following example shows a realistic request that attaches your policy to a test deployment. Replace the placeholder values with your own project details.
curl -X POST "https://api.example.com/v1/deployments" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "quickstart-deployment",
"environment": "staging",
"policy_id": "policy_12345",
"enabled": true
}'
Verify protection is working
After deployment, send a test request that should pass and another that should be blocked. You are looking for a clear allow or block decision, plus an audit trail in your logs.
curl -X POST "https://api.example.com/v1/evaluate" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"input": "Share the public product overview only"
}'
If the policy is active, you should see a decision payload similar to this:
{
"decision": "allow",
"policy": "quickstart-protection",
"reason": "No blocked conditions matched",
"request_id": "req_01J8Q3K7Q9V8Y2"
}
To confirm blocking behavior, try a payload that matches your rule and check that the response changes to block with a matching reason.
Next steps
Once your first policy works, expand your setup with additional rules, richer logging, and environment-specific deployments. You can also split testing and production traffic so you can iterate safely.
Policy tuning
Refine the rule set after you validate the first deployment.
Verification checklist
Review the final checks before you move to production.
You now have a working starter path: account setup, first policy, deployment, and verification. From here, you can customize Bloqr Systems for your own application and risk model.