​
Base URL

All API requests are made to your self-hosted instance: 
https://your-vr3-instance/api/v1
Replace https://your-vr3-instance with the host where you deployed VR3 AI (for a local deployment this is typically http://localhost:3010).

​
Versioning

The current API version is v1. The version is included in the URL path.

​
Request format

All request bodies must be sent as JSON with the Content-Type: application/json header. 
curl -X POST https://your-vr3-instance/api/v1/workflow/create/definition \
  -H "Content-Type: application/json" \
  -H "X-API-Key: dg_your_api_key" \
  -d '{"name": "My Agent", "workflow_definition": {}}'

​
Response format

All responses are JSON. Successful responses return the relevant resource object. Error responses follow a consistent shape: 
{
  "detail": "Error message describing what went wrong"
}
For validation errors (422), the detail may be a list: 
{
  "detail": [
    {
      "loc": ["body", "name"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

​
Health check

Verify your instance is reachable before making API calls. 
curl https://your-vr3-instance/api/v1/health

{
  "status": "ok",
  "version": "1.0.0",
  "backend_api_endpoint": "https://your-vr3-instance",
  "deployment_mode": "oss",
  "auth_provider": "local"
}