Getting Started

note

API paths that contain tenant keep that word for compatibility. In the product it means your workspace.

This quickstart covers the baseline authentication pattern that every integration must follow.

Docs versioning

Dralvia ships a single living documentation surface. These pages always describe the platform that is live right now, so there is no version to choose and no pinned snapshot to fall behind. Breaking changes are announced in the changelog.

Prerequisites

1. Base URL: for Dralvia SaaS, use https://dralvia.tech/api/tenant.
2. API key: generate it in the portal (https://dralvia.tech/#/api-keys). Send it as Authorization: Api-Key … (or X-API-KEY). Store it in Vault/your secret manager and never commit it to git.
3. Signed-in session: browser-only console actions use your Dralvia sign-in session. Service integrations should use workspace API keys.
4. Workspace access: confirm your plan includes the API surface you want to call.

Minimal request

curl -sS -X POST "https://dralvia.tech/api/tenant/scan" \
  -H "Authorization: Api-Key $DRALVIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com"}'

The response contains the score, flags, EvidencePack (Dralvia's exportable evidence report) pointers, and persona-ready explainability.

SDK bootstrap

Python

from dralvia_sdk import DralviaClient

client = DralviaClient(
    base_url="https://dralvia.tech/api/tenant",
    api_key=os.environ["DRALVIA_API_KEY"],
)

result = client.scan_url("https://example.com")
print(result["risk_level"], result["score"])

JavaScript

import { DralviaClient } from "@dralvia/sdk";

const client = new DralviaClient({
  baseUrl: "https://dralvia.tech/api/tenant",
  apiKey: process.env.DRALVIA_API_KEY,
});

const data = await client.scanUrl("https://example.com");
console.log(data.risk_level, data.score);

The SDK package names shown above are not public npm or PyPI packages today; the SDK is repo-local today and its source is public on GitHub at https://github.com/Dralvia/dralvia-sdk. Use the SDK guides for the exact client steps: sign in, generate a workspace API key, install from the public GitHub source, set DRALVIA_API_KEY, and run a first scan.

Where to go next

• URL & phishing scanner API: domain scan parameters and EvidencePack artifacts.
• First-user workflows: the fastest URL, smart contract, repository, and email paths to prove value.
• SWG dry-run + remote rendering: policy evaluation and adaptive shadow browsing.
• Python SDK guide and JavaScript SDK guide: exact client setup steps and first-scan examples.
• Postman collection: import the ready-made collection to exercise the APIs manually.