All requests go through a single API gateway URL that routes to the appropriate backend service.
Prerequisites
-
API gateway URL — the external address of your Vijil Console deployment (e.g.
https://console-api.example.com)
-
User credentials — an email and password for an existing Vijil Console account
Set a shell variable for convenience:
Authenticate
Exchange your credentials for a JWT access token:
Response:
Save the token:
All subsequent requests include this header:
Select a Team
Most operations are scoped to a team. List your team memberships:
Response:
Save the team_id value:
Register an Agent
Create an agent configuration pointing at the AI model you want to evaluate.
The team is derived from your JWT token, so no team_id parameter is needed:
Required fields:
-
agent_name — a display name for the agent
-
model_name — the model identifier (e.g. gpt-4, claude-sonnet-4-20250514)
Optional fields:
-
agent_url — the endpoint the agent is reachable at
-
api_key — API key for the agent’s provider
-
agent_system_prompt — system prompt the agent uses
Response (HTTP 201):
Save the agent ID:
List Agents
Verify the agent was created:
Response:
List Available Harnesses
Harnesses are test suites that evaluate different trust dimensions. List the standard Harnesses:
Response:
Run an Evaluation
Start a trust evaluation against your agent. Evaluations run asynchronously — the API returns immediately with a 202 Accepted status.
Required fields:
-
agent_id — UUID of the agent to evaluate
-
team_id — UUID of the team
-
harness_names — list of Harness names to run (at least one)
Optional fields:
-
sample_size — number of prompts to run (1-1000); omit to run all prompts
-
harness_type — "standard" (default) or "custom"
Response (HTTP 202):
Save the evaluation ID:
Check Evaluation Status
Poll until the evaluation completes:
Response:
When polling, the status field progresses through: starting -> pending -> running -> completed -> saving -> saved. It may also be failed or canceled.
When the status is completed, the scores field contains per-Harness scores:
View Evaluation Results
Retrieve the full results once the evaluation has completed:
This returns the detailed results JSON including per-Harness breakdowns, individual Probe results, and analysis.
Download the Report
Get the evaluation report as HTML:
Or as PDF:
Next Steps
-
Custom Harnesses — create test suites tailored to your use case with
POST /custom-harnesses/
-
Personas — define user archetypes for testing with
POST /personas/ or copy from presets with POST /personas/from-preset/{preset_id}
-
Policies — manage compliance policies and rules with
POST /policies/
-
DOME Guardrails — configure runtime protection with
POST /dome-configs
-
Red team campaigns — run adversarial attack campaigns with
POST /redteam/campaigns
-
Full API reference — browse the interactive docs at
$VIJIL_URL/docs
Last modified on June 13, 2026
