Sandbox

What the sandbox is

The sandbox is a physically separate environment at https://sandbox-api.kliq-ai.eu. It runs its own database seeded with anonymized Duvel demo data (real store structure, scrubbed identities) and its own CV pipeline, so you can submit observations, trigger grading jobs, and explore every API endpoint without affecting live data.

Key properties:

• Isolated by key prefix. A kliq_test_ key cannot reach api.kliq-ai.eu, and a kliq_sk_ key cannot reach sandbox-api.kliq-ai.eu. The server rejects the wrong prefix with 401 Unauthorized. See Environments for the full environment matrix.
• Seeded demo data. Locations, stores, catalog items, and past observations are pre-populated so you can read data immediately without creating anything first.
• No live-data features. Salesforce push, WhatsApp notifications, and other outbound integrations are disabled in the sandbox. API calls that trigger those integrations succeed locally but the external side-effect is suppressed.

How to get a sandbox key

Sandbox keys are issued by the KLIQ team. They are not self-serve. Contact your account executive or email sdk@kliq-ai.eu and request a sandbox key. The KLIQ team provisions it through the platform-admin sandbox panel and sends you a kliq_test_ key by secure channel.

Limits

The sandbox is intentionally constrained to prevent runaway usage during evaluation:

When your credit balance reaches zero, every API call that consumes credits returns 402 Payment Required. Read-only calls (listing locations, fetching results) do not consume credits and continue to work after balance is exhausted.

Keys can be revoked at any time by the KLIQ team. A revoked key returns 401 Unauthorized on all requests.

Connect the SDK to the sandbox

Pass environment: 'test' when initializing KliqClient. A kliq_test_ key also auto-routes to the sandbox if you omit the environment option, but the explicit form is recommended — it is self-documenting and will be caught by type-checking if you accidentally swap a production key.

import { KliqClient } from '@kliq-ai/sdk';

const kliq = new KliqClient({
apiKey: process.env.KLIQ_TEST_API_KEY!, // kliq_test_...
environment: 'test',
});

// Scope to your sandbox tenant (provided with your key)
const tenant = kliq.forTenant('YOUR_SANDBOX_TENANT_ID');

// List pre-seeded demo locations
const locations = await tenant.locations.list();
console.log(locations.data);

Try it now

The playground below calls a read endpoint on the sandbox using a shared demo key. No API key required on your end — the proxy holds the credentials server-side.

Sandbox vs. production comparison

Next steps