API reference
Overview
Every endpoint, generated from the API's own OpenAPI document (openapi.json, API 0.2.0). Requests and responses are JSON.
Base URL and keys
Every /v1 call takes an API key as a bearer token: vx_test_… or vx_live_… (API keys & modes). Errors are application/problem+json with a stable code, and every response carries rate-limit headers (Rate limits & errors).
export VINDEX_KEY=vx_test_...
curl https://api.getvindex.com/v1/tenant -H "Authorization: Bearer $VINDEX_KEY"Endpoints
Check
Screen a prompt against a policy and get a decision back.
Decisions
The decision log: list, fetch, and explain in plain words.
Policies
Policies, their versions and the shipped presets.
- GET
/v1/policiesList policies - POST
/v1/policiesCreate a policy from a preset or a document - GET
/v1/policies/{id}Get a policy, its current document and its versions - POST
/v1/policies/{id}/versionsAdd a new (unpublished) version - POST
/v1/policies/{id}/publishPublish a version - POST
/v1/policies/{id}/defaultMake a policy the tenant's default - GET
/v1/policies/{id}/versions/{version}Get one version of a policy - GET
/v1/presetsList preset policies
Review
The review queue and verdicts.
Keys
Create, list and revoke API keys.
Tenant
Your workspace, including shadow mode.
Meta
Health and pointers. No key needed.