API reference

Responses

• 200 The API index.

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1" \
  -H "Vouli-Version: 2026-09-12"

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1', {
  method: 'GET',
  headers: {
    'Vouli-Version': '2026-09-12',
  },
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import urllib.request

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1",
    method="GET",
    headers={"Vouli-Version": "2026-09-12"},
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Try it

Responses

• 200 The OpenAPI 3.1 document.

object

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/openapi.json" \
  -H "Vouli-Version: 2026-09-12"

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/openapi.json', {
  method: 'GET',
  headers: {
    'Vouli-Version': '2026-09-12',
  },
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import urllib.request

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/openapi.json",
    method="GET",
    headers={"Vouli-Version": "2026-09-12"},
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Try it

Parameters

Request body (application/json, required)

{
  "jsonrpc": "2.0",
  "id": "example_id",
  "method": "initialize",
  "params": {}
}

Responses

• 200 A JSON-RPC 2.0 response: a result, or an error for an unknown method or invalid params.
• 202 A notification (or a client response) was accepted. No body.
• 400 Parse error (-32700), an invalid or batched message (-32600), or an unsupported MCP-Protocol-Version.
• 401 No key, or the key does not verify. Carries WWW-Authenticate: Bearer.
• 403 The plan does not include API access, the subscription is not live, or the request came from a foreign browser origin.
• 413 Body over 64 KB.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/mcp" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":"example_id","method":"initialize","params":{}}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/mcp', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 'example_id',
    method: 'initialize',
    params: {},
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/mcp",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Content-Type": "application/json"},
    data=json.dumps({
        "jsonrpc": "2.0",
        "id": "example_id",
        "method": "initialize",
        "params": {},
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Responses

• 200 The current object, or null.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

{
  "object": "compliance_posture",
  "id": "00000000-0000-4000-8000-000000000601",
  "version_number": 2,
  "overall_posture": "PARTIAL",
  "primary_jurisdictions": [
    "EU",
    "UK",
    "IN"
  ],
  "regimes": [
    {
      "regime_id": "eu-ai-act",
      "posture": "PARTIAL",
      "open_obligations": 4
    }
  ],
  "executive_summary": "[SANDBOX] Four EU AI Act obligations are open, two of them high priority.",
  "generated_at": "2026-09-01T09:00:00.000Z"
}

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/compliance" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const result = await vouli.compliance();
console.log(result.data);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

result = vouli.compliance()
print(result["data"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "obligation",
    "id": "00000000-0000-4000-8000-000000000701",
    "obligation_key": "SANDBOX-O-001",
    "regime_id": "eu-ai-act",
    "regime_name": "EU AI Act",
    "jurisdiction": "EU",
    "title": "[SANDBOX] Maintain technical documentation for each high-risk system.",
    "priority_band": "HIGH",
    "status": "open",
    "owner_role": "Head of Compliance",
    "target_date": "2026-12-01",
    "created_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "obligation",
    "id": "00000000-0000-4000-8000-000000000702",
    "obligation_key": "SANDBOX-O-002",
    "regime_id": "dpdp",
    "regime_name": "India DPDP Act",
    "jurisdiction": "IN",
    "title": "[SANDBOX] Register a grievance officer and publish the contact route.",
    "priority_band": "MEDIUM",
    "status": "in_progress",
    "owner_role": null,
    "target_date": null,
    "created_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/compliance/obligations?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.obligations({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.obligations(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "incident",
    "id": "00000000-0000-4000-8000-000000001201",
    "title": "[SANDBOX] Credit model drifted outside its approved fairness band",
    "description": "[SANDBOX] Approval-rate gap between cohorts exceeded the approved threshold for two days.",
    "incident_type": "bias_harm",
    "severity": "high",
    "status": "investigating",
    "affected_systems": "[SANDBOX] Credit decisioning",
    "jurisdictions": "EU",
    "owner": "[SANDBOX] Head of Model Risk",
    "notification_required": true,
    "notification_deadline": "2026-09-04T09:00:00.000Z",
    "notified_at": null,
    "created_at": "2026-09-01T09:00:00.000Z",
    "updated_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "incident",
    "id": "00000000-0000-4000-8000-000000001202",
    "title": "[SANDBOX] Support agent quoted an unpublished refund policy",
    "description": null,
    "incident_type": "agent_failure",
    "severity": "medium",
    "status": "resolved",
    "affected_systems": null,
    "jurisdictions": null,
    "owner": null,
    "notification_required": false,
    "notification_deadline": null,
    "notified_at": null,
    "created_at": "2026-08-01T09:00:00.000Z",
    "updated_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/incidents?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.incidents({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.incidents(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Request body (application/json, required)

{
  "affected_systems": "example_affected_systems",
  "description": "example_description",
  "incident_type": "model_failure",
  "jurisdictions": "example_jurisdictions",
  "notification_deadline": "2026-01-01T00:00:00.000Z",
  "notification_required": true,
  "owner": "example_owner",
  "severity": "low",
  "status": "open",
  "title": "example_title"
}

Responses

• 201 Created. The record as stored.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/incidents" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"affected_systems":"example_affected_systems","description":"example_description","incident_type":"model_failure","jurisdictions":"example_jurisdictions","notification_deadline":"2026-01-01T00:00:00.000Z","notification_required":true,"owner":"example_owner","severity":"low","status":"open","title":"example_title"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/incidents', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    affected_systems: 'example_affected_systems',
    description: 'example_description',
    incident_type: 'model_failure',
    jurisdictions: 'example_jurisdictions',
    notification_deadline: '2026-01-01T00:00:00.000Z',
    notification_required: true,
    owner: 'example_owner',
    severity: 'low',
    status: 'open',
    title: 'example_title',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/incidents",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "affected_systems": "example_affected_systems",
        "description": "example_description",
        "incident_type": "model_failure",
        "jurisdictions": "example_jurisdictions",
        "notification_deadline": "2026-01-01T00:00:00.000Z",
        "notification_required": True,
        "owner": "example_owner",
        "severity": "low",
        "status": "open",
        "title": "example_title",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Request body (application/json, required)

{
  "affected_systems": "example_affected_systems",
  "description": "example_description",
  "incident_type": "model_failure",
  "jurisdictions": "example_jurisdictions",
  "notification_deadline": "2026-01-01T00:00:00.000Z",
  "notification_required": true,
  "owner": "example_owner",
  "severity": "low",
  "status": "open",
  "title": "example_title"
}

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X PATCH "https://www.vouliiq.com/api/v1/incidents/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"affected_systems":"example_affected_systems","description":"example_description","incident_type":"model_failure","jurisdictions":"example_jurisdictions","notification_deadline":"2026-01-01T00:00:00.000Z","notification_required":true,"owner":"example_owner","severity":"low","status":"open","title":"example_title"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/incidents/00000000-0000-4000-8000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    affected_systems: 'example_affected_systems',
    description: 'example_description',
    incident_type: 'model_failure',
    jurisdictions: 'example_jurisdictions',
    notification_deadline: '2026-01-01T00:00:00.000Z',
    notification_required: true,
    owner: 'example_owner',
    severity: 'low',
    status: 'open',
    title: 'example_title',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/incidents/00000000-0000-4000-8000-000000000000",
    method="PATCH",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "affected_systems": "example_affected_systems",
        "description": "example_description",
        "incident_type": "model_failure",
        "jurisdictions": "example_jurisdictions",
        "notification_deadline": "2026-01-01T00:00:00.000Z",
        "notification_required": True,
        "owner": "example_owner",
        "severity": "low",
        "status": "open",
        "title": "example_title",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "kpi",
    "id": "00000000-0000-4000-8000-000000001301",
    "code": "SANDBOX-O1-KR1",
    "objective_id": "00000000-0000-4000-8000-000000001300",
    "statement": "[SANDBOX] Lift the share of AI use cases with a named accountable owner to 90%.",
    "metric_name": "[SANDBOX] Use cases with an accountable owner",
    "unit": "%",
    "direction": "increase",
    "baseline_value": 42,
    "target_value": 90,
    "current_value": 61,
    "current_as_of": "2026-09-01T09:00:00.000Z",
    "measurement_frequency": "monthly",
    "status": "active",
    "created_at": "2026-09-01T09:00:00.000Z",
    "updated_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "kpi",
    "id": "00000000-0000-4000-8000-000000001302",
    "code": "SANDBOX-O1-KR2",
    "objective_id": "00000000-0000-4000-8000-000000001300",
    "statement": "[SANDBOX] Cut median model-approval cycle time to 10 days.",
    "metric_name": "[SANDBOX] Median approval cycle time",
    "unit": "days",
    "direction": "decrease",
    "baseline_value": 34,
    "target_value": 10,
    "current_value": null,
    "current_as_of": null,
    "measurement_frequency": "quarterly",
    "status": "active",
    "created_at": "2026-08-01T09:00:00.000Z",
    "updated_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/kpis?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.kpis({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.kpis(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Request body (application/json, required)

{
  "checkins": [
    {
      "evidence_ref": "example_evidence_ref",
      "key_result_code": "example_key_result_code",
      "key_result_id": "00000000-0000-4000-8000-000000000000",
      "note": "example_note",
      "period_start": "example_period_start",
      "source": "telemetry",
      "value": 1
    }
  ]
}

Responses

• 201 Created. The record as stored.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 512 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/kpis/checkins" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"checkins":[{"evidence_ref":"example_evidence_ref","key_result_code":"example_key_result_code","key_result_id":"00000000-0000-4000-8000-000000000000","note":"example_note","period_start":"example_period_start","source":"telemetry","value":1}]}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/kpis/checkins', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    checkins: [
      {
        evidence_ref: 'example_evidence_ref',
        key_result_code: 'example_key_result_code',
        key_result_id: '00000000-0000-4000-8000-000000000000',
        note: 'example_note',
        period_start: 'example_period_start',
        source: 'telemetry',
        value: 1,
      },
    ],
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/kpis/checkins",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "checkins": [
            {
                "evidence_ref": "example_evidence_ref",
                "key_result_code": "example_key_result_code",
                "key_result_id": "00000000-0000-4000-8000-000000000000",
                "note": "example_note",
                "period_start": "example_period_start",
                "source": "telemetry",
                "value": 1,
            },
        ],
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "risk",
    "id": "00000000-0000-4000-8000-000000000201",
    "risk_id": "SANDBOX-R-001",
    "dimension": "Oversight",
    "description": "[SANDBOX] No named accountable owner for model approvals.",
    "severity": "CRITICAL",
    "residual_severity": "HIGH",
    "status": "Open",
    "source": "sovereign_red",
    "owner_name": "[SANDBOX] Chief Risk Officer",
    "financial_exposure_min": 250000,
    "financial_exposure_max": 1200000,
    "target_date": "2026-12-31",
    "created_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "risk",
    "id": "00000000-0000-4000-8000-000000000202",
    "risk_id": "SANDBOX-R-002",
    "dimension": "Value",
    "description": "[SANDBOX] Benefit claims for two initiatives are unevidenced.",
    "severity": "HIGH",
    "residual_severity": "MEDIUM",
    "status": "InProgress",
    "source": "ai_generated",
    "owner_name": "[SANDBOX] CFO",
    "financial_exposure_min": 80000,
    "financial_exposure_max": 300000,
    "target_date": null,
    "created_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/risks?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.risks({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.risks(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Request body (application/json, required)

{
  "description": "example_description",
  "dimension": "example_dimension",
  "likelihood": "RARE",
  "mitigation_action": "example_mitigation_action",
  "owner_name": "example_owner_name",
  "severity": "CRITICAL",
  "target_date": "example_target_date",
  "title": "example_title"
}

Responses

• 201 Created. The record as stored.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/risks" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"description":"example_description","dimension":"example_dimension","likelihood":"RARE","mitigation_action":"example_mitigation_action","owner_name":"example_owner_name","severity":"CRITICAL","target_date":"example_target_date","title":"example_title"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/risks', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    description: 'example_description',
    dimension: 'example_dimension',
    likelihood: 'RARE',
    mitigation_action: 'example_mitigation_action',
    owner_name: 'example_owner_name',
    severity: 'CRITICAL',
    target_date: 'example_target_date',
    title: 'example_title',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/risks",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "description": "example_description",
        "dimension": "example_dimension",
        "likelihood": "RARE",
        "mitigation_action": "example_mitigation_action",
        "owner_name": "example_owner_name",
        "severity": "CRITICAL",
        "target_date": "example_target_date",
        "title": "example_title",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Request body (application/json, required)

{
  "likelihood": "RARE",
  "mitigation_action": "example_mitigation_action",
  "owner_name": "example_owner_name",
  "residual_gap_reason": "example_residual_gap_reason",
  "residual_severity": "CRITICAL",
  "severity": "CRITICAL",
  "severity_change_reason": "example_severity_change_reason",
  "status": "Open",
  "target_date": "example_target_date",
  "title": "example_title"
}

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X PATCH "https://www.vouliiq.com/api/v1/risks/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"likelihood":"RARE","mitigation_action":"example_mitigation_action","owner_name":"example_owner_name","residual_gap_reason":"example_residual_gap_reason","residual_severity":"CRITICAL","severity":"CRITICAL","severity_change_reason":"example_severity_change_reason","status":"Open","target_date":"example_target_date","title":"example_title"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/risks/00000000-0000-4000-8000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    likelihood: 'RARE',
    mitigation_action: 'example_mitigation_action',
    owner_name: 'example_owner_name',
    residual_gap_reason: 'example_residual_gap_reason',
    residual_severity: 'CRITICAL',
    severity: 'CRITICAL',
    severity_change_reason: 'example_severity_change_reason',
    status: 'Open',
    target_date: 'example_target_date',
    title: 'example_title',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/risks/00000000-0000-4000-8000-000000000000",
    method="PATCH",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "likelihood": "RARE",
        "mitigation_action": "example_mitigation_action",
        "owner_name": "example_owner_name",
        "residual_gap_reason": "example_residual_gap_reason",
        "residual_severity": "CRITICAL",
        "severity": "CRITICAL",
        "severity_change_reason": "example_severity_change_reason",
        "status": "Open",
        "target_date": "example_target_date",
        "title": "example_title",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Responses

• 200 The current object, or null.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

{
  "object": "roadmap",
  "id": "00000000-0000-4000-8000-000000000401",
  "version_number": 3,
  "executive_summary": "[SANDBOX] Three-phase plan: stabilise oversight, then prove value, then scale.",
  "framework_blend": {
    "NIST AI RMF": 0.6,
    "ISO/IEC 42001": 0.4
  },
  "phases": [
    {
      "phase": "Phase 1",
      "objective": "[SANDBOX] Stand up the governance spine."
    },
    {
      "phase": "Phase 2",
      "objective": "[SANDBOX] Evidence the value of three initiatives."
    }
  ],
  "milestones_count": 2,
  "generated_at": "2026-09-01T09:00:00.000Z"
}

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/roadmap" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const result = await vouli.roadmap();
console.log(result.data);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

result = vouli.roadmap()
print(result["data"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "milestone",
    "id": "00000000-0000-4000-8000-000000000501",
    "roadmap_id": "00000000-0000-4000-8000-000000000401",
    "milestone_key": "SANDBOX-M-001",
    "title": "[SANDBOX] Appoint an accountable owner for model approvals.",
    "phase": "Phase 1",
    "sequence": 1,
    "status": "in_progress",
    "rag_status": "AMBER",
    "progress_pct": 40,
    "owner_role": "Chief Risk Officer",
    "target_date": "2026-11-30",
    "created_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "milestone",
    "id": "00000000-0000-4000-8000-000000000502",
    "roadmap_id": "00000000-0000-4000-8000-000000000401",
    "milestone_key": "SANDBOX-M-002",
    "title": "[SANDBOX] Publish the model inventory to the board.",
    "phase": "Phase 2",
    "sequence": 1,
    "status": "not_started",
    "rag_status": "GREEN",
    "progress_pct": 0,
    "owner_role": "CIO",
    "target_date": null,
    "created_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/roadmap/milestones?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.milestones({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.milestones(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "score",
    "id": "00000000-0000-4000-8000-000000000101",
    "overall_score": 61.5,
    "adjusted_score": 58.2,
    "verdict": "REMEDIATION",
    "confidence": 0.82,
    "methodology_version": "2.0-weighted (SANDBOX)",
    "completed_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "score",
    "id": "00000000-0000-4000-8000-000000000102",
    "overall_score": 54,
    "adjusted_score": 50.1,
    "verdict": "REMEDIATION",
    "confidence": 0.77,
    "methodology_version": "2.0-weighted (SANDBOX)",
    "completed_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/scores?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.scores({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.scores(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Responses

• 200 The current object, or null.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

{
  "object": "scorecard",
  "id": "00000000-0000-4000-8000-000000000101",
  "overall_score": 61.5,
  "adjusted_score": 58.2,
  "verdict": "REMEDIATION",
  "confidence": 0.82,
  "completeness": 0.94,
  "evidence_ratio": 0.61,
  "methodology_version": "2.0-weighted (SANDBOX)",
  "frameworks_applied": [
    "NIST AI RMF",
    "ISO/IEC 42001"
  ],
  "completed_at": "2026-09-01T09:00:00.000Z"
}

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/scorecard" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const result = await vouli.scorecard();
console.log(result.data);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

result = vouli.scorecard()
print(result["data"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "signal",
    "id": "00000000-0000-4000-8000-000000000301",
    "signal_type": "maturity.overall",
    "module_id": "M1",
    "numeric_value": 61.5,
    "rag": "AMBER",
    "source_version": "2.0-weighted (SANDBOX)",
    "as_of": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "signal",
    "id": "00000000-0000-4000-8000-000000000302",
    "signal_type": "risk.exposure_usd",
    "module_id": "M6",
    "numeric_value": 1500000,
    "rag": "RED",
    "source_version": null,
    "as_of": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/signals?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.signals({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.signals(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Responses

• 200 The current object, or null.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

{
  "object": "talent_readiness",
  "id": "00000000-0000-4000-8000-000000001001",
  "version_number": 1,
  "overall_readiness": "DEVELOPING",
  "executive_summary": "[SANDBOX] Governance capability is the binding constraint, not engineering.",
  "build_buy_borrow": {
    "build": 0.4,
    "buy": 0.35,
    "borrow": 0.25
  },
  "generated_at": "2026-09-01T09:00:00.000Z"
}

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/talent" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const result = await vouli.talent();
console.log(result.data);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

result = vouli.talent()
print(result["data"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "talent_gap",
    "id": "00000000-0000-4000-8000-000000001101",
    "gap_key": "SANDBOX-G-001",
    "role_title": "[SANDBOX] AI Assurance Lead",
    "function_area": "Risk & Compliance",
    "headcount_needed": 1,
    "priority_band": "HIGH",
    "recommended_path": "BUY",
    "status": "open",
    "owner_role": "CHRO",
    "target_date": "2026-11-15",
    "created_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "talent_gap",
    "id": "00000000-0000-4000-8000-000000001102",
    "gap_key": "SANDBOX-G-002",
    "role_title": "[SANDBOX] MLOps Engineer",
    "function_area": "Engineering",
    "headcount_needed": 2,
    "priority_band": "MEDIUM",
    "recommended_path": "BUILD",
    "status": "in_progress",
    "owner_role": null,
    "target_date": null,
    "created_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/talent/gaps?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.gaps({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.gaps(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Responses

• 200 The current object, or null.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

{
  "object": "vendor_portfolio",
  "id": "00000000-0000-4000-8000-000000000801",
  "version_number": 1,
  "portfolio_posture": "CONCENTRATED",
  "executive_summary": "[SANDBOX] Two of three model vendors share one upstream provider.",
  "cross_vendor_risks": [
    "[SANDBOX] Shared upstream provider concentration."
  ],
  "recommended_actions": [
    {
      "action": "[SANDBOX] Qualify a second inference provider.",
      "priority": "HIGH"
    }
  ],
  "generated_at": "2026-09-01T09:00:00.000Z"
}

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/vendor" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const result = await vouli.vendor();
console.log(result.data);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

result = vouli.vendor()
print(result["data"])

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

[
  {
    "object": "vendor",
    "id": "00000000-0000-4000-8000-000000000901",
    "vendor_key": "SANDBOX-V-001",
    "vendor_name": "[SANDBOX] Northwind Models",
    "category": "Foundation model API",
    "ai_role": "inference",
    "initial_risk_band": "HIGH",
    "initial_recommendation": "RENEGOTIATE",
    "status": "under_review",
    "contract_end": "2027-03-31",
    "annual_cost_usd": 420000,
    "created_at": "2026-09-01T09:00:00.000Z"
  },
  {
    "object": "vendor",
    "id": "00000000-0000-4000-8000-000000000902",
    "vendor_key": "SANDBOX-V-002",
    "vendor_name": "[SANDBOX] Contoso Vector",
    "category": "Vector database",
    "ai_role": "retrieval",
    "initial_risk_band": "MEDIUM",
    "initial_recommendation": "RETAIN",
    "status": "approved",
    "contract_end": null,
    "annual_cost_usd": 60000,
    "created_at": "2026-08-01T09:00:00.000Z"
  }
]

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/vendor/inventory?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript SDK

import { VouliIQ } from '@vouli-iq/sdk';

const vouli = new VouliIQ({ apiKey: process.env.VOULI_API_KEY! });

const page = await vouli.inventory({ limit: 10 });
console.log(page.data, page.has_more, page.next_cursor);

Python SDK

import os
from vouli_iq import VouliIQ

vouli = VouliIQ(api_key=os.environ["VOULI_API_KEY"])

page = vouli.inventory(limit=10)
print(page["data"], page["has_more"], page["next_cursor"])

Try it

Parameters

Request body (application/json, required)

{
  "ai_role": "example_ai_role",
  "annual_cost_usd": 0,
  "category": "example_category",
  "contract_end": "example_contract_end",
  "contract_start": "example_contract_start",
  "initial_recommendation": "consolidate",
  "initial_risk_band": "CRITICAL",
  "notes": "example_notes",
  "renewal_owner_role": "example_renewal_owner_role",
  "status": "active",
  "vendor_key": "example_vendor_key",
  "vendor_name": "example_vendor_name"
}

Responses

• 201 Created. The record as stored.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/vendor/inventory" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"ai_role":"example_ai_role","annual_cost_usd":0,"category":"example_category","contract_end":"example_contract_end","contract_start":"example_contract_start","initial_recommendation":"consolidate","initial_risk_band":"CRITICAL","notes":"example_notes","renewal_owner_role":"example_renewal_owner_role","status":"active","vendor_key":"example_vendor_key","vendor_name":"example_vendor_name"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/vendor/inventory', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    ai_role: 'example_ai_role',
    annual_cost_usd: 0,
    category: 'example_category',
    contract_end: 'example_contract_end',
    contract_start: 'example_contract_start',
    initial_recommendation: 'consolidate',
    initial_risk_band: 'CRITICAL',
    notes: 'example_notes',
    renewal_owner_role: 'example_renewal_owner_role',
    status: 'active',
    vendor_key: 'example_vendor_key',
    vendor_name: 'example_vendor_name',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/vendor/inventory",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "ai_role": "example_ai_role",
        "annual_cost_usd": 0,
        "category": "example_category",
        "contract_end": "example_contract_end",
        "contract_start": "example_contract_start",
        "initial_recommendation": "consolidate",
        "initial_risk_band": "CRITICAL",
        "notes": "example_notes",
        "renewal_owner_role": "example_renewal_owner_role",
        "status": "active",
        "vendor_key": "example_vendor_key",
        "vendor_name": "example_vendor_name",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Request body (application/json, required)

{
  "annual_cost_usd": 0,
  "contract_end": "example_contract_end",
  "contract_start": "example_contract_start",
  "notes": "example_notes",
  "renewal_owner_role": "example_renewal_owner_role",
  "status": "active"
}

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X PATCH "https://www.vouliiq.com/api/v1/vendor/inventory/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"annual_cost_usd":0,"contract_end":"example_contract_end","contract_start":"example_contract_start","notes":"example_notes","renewal_owner_role":"example_renewal_owner_role","status":"active"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/vendor/inventory/00000000-0000-4000-8000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    annual_cost_usd: 0,
    contract_end: 'example_contract_end',
    contract_start: 'example_contract_start',
    notes: 'example_notes',
    renewal_owner_role: 'example_renewal_owner_role',
    status: 'active',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/vendor/inventory/00000000-0000-4000-8000-000000000000",
    method="PATCH",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "annual_cost_usd": 0,
        "contract_end": "example_contract_end",
        "contract_start": "example_contract_start",
        "notes": "example_notes",
        "renewal_owner_role": "example_renewal_owner_role",
        "status": "active",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/audit?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/audit?limit=10', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
  },
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/audit?limit=10",
    method="GET",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12"},
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Try it

Parameters

Responses

• 200 A page of results.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.

Examples

curl

curl -X GET "https://www.vouliiq.com/api/v1/webhooks/subscriptions?limit=10" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12"

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/webhooks/subscriptions?limit=10', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
  },
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/webhooks/subscriptions?limit=10",
    method="GET",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12"},
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Try it

Parameters

Request body (application/json, required)

{
  "active": true,
  "description": "example_description",
  "event_types": [
    "example_event_types"
  ],
  "url": "example_url"
}

Responses

• 201 Created. The record as stored.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/webhooks/subscriptions" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"active":true,"description":"example_description","event_types":["example_event_types"],"url":"example_url"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/webhooks/subscriptions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    active: true,
    description: 'example_description',
    event_types: [
      'example_event_types',
    ],
    url: 'example_url',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/webhooks/subscriptions",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "active": True,
        "description": "example_description",
        "event_types": [
            "example_event_types",
        ],
        "url": "example_url",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Request body (application/json, required)

{
  "active": true,
  "description": "example_description",
  "event_types": [
    "example_event_types"
  ],
  "url": "example_url"
}

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X PATCH "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"active":true,"description":"example_description","event_types":["example_event_types"],"url":"example_url"}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    active: true,
    description: 'example_description',
    event_types: [
      'example_event_types',
    ],
    url: 'example_url',
  }),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000",
    method="PATCH",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({
        "active": True,
        "description": "example_description",
        "event_types": [
            "example_event_types",
        ],
        "url": "example_url",
    }).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X DELETE "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)"

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000",
    method="DELETE",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4())},
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))

Parameters

Request body (application/json)

object

{}

Responses

• 200 Done. The record as it now stands.
• 400 Malformed request: a bad limit, a cursor we did not issue, an unknown filter value, or an unsupported version.
• 401 No key presented, or the key does not verify (revoked, expired, mistyped).
• 403 The key verified but the plan does not include API access, or the key lacks the resource’s scope.
• 404 No such record in this organisation.
• 409 Idempotency conflict (key reused with another body, or still in flight), or a duplicate record (resource_conflict).
• 413 Body over 64 KB.
• 415 Body sent with a Content-Type other than application/json.
• 429 Per-key rate limit exhausted. Wait Retry-After seconds.
• 500 Something failed on our side. The request_id identifies this exact request.
• 503 The idempotency store or the module is unavailable; nothing was done. Retry with the same Idempotency-Key.

Examples

curl

curl -X POST "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000/test" \
  -H "Authorization: Bearer $VOULI_API_KEY" \
  -H "Vouli-Version: 2026-09-12" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript

// Not wrapped by the SDK: a plain HTTP call.
const res = await fetch('https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOULI_API_KEY}`,
    'Vouli-Version': '2026-09-12',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(res.status, await res.json());

Python

# Not wrapped by the SDK: a plain HTTP call.
import json
import os
import urllib.request
import uuid

req = urllib.request.Request(
    "https://www.vouliiq.com/api/v1/webhooks/subscriptions/00000000-0000-4000-8000-000000000000/test",
    method="POST",
    headers={"Authorization": f"Bearer {os.environ['VOULI_API_KEY']}", "Vouli-Version": "2026-09-12", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json"},
    data=json.dumps({}).encode(),
)
with urllib.request.urlopen(req) as res:
    print(res.status, json.loads(res.read()))