Connect your own systems to the OS. Read projects, tasks and risks, run AI agents and track usage — over a simple, key-authenticated REST API. Calls are metered against your plan; agent runs draw down prepaid ACU.
Sign in → Business → API & Developers → Create API key. The secret is shown once.
Send Authorization: Bearer vx_… (or the X-API-Key header) on every request.
Hit the endpoints below. Watch usage and ACU in your workspace.
Base URL https://www.veryxjnn.com/api/public/v1 Auth Authorization: Bearer vx_live_xxx (or) X-API-Key: vx_live_xxx curl -H "Authorization: Bearer vx_test_..." https://www.veryxjnn.com/api/public/v1/ping
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /ping | — | Verify a key and see the workspace it unlocks. |
| GET | /projects | read:projects | List the workspace projects and portfolios. |
| GET | /tasks | read:tasks | List schedule tasks (optionally by ?project_id=). |
| GET | /risks | read:risks | Read the risk register, highest score first. |
| GET | /agents | read:agents | List the AI agents you can run and their ACU cost. |
| POST | /agents/{type}/run | run:agents | Run an AI agent. Consumes prepaid ACU. |
| GET | /usage | read:usage | Your monthly quota, usage and ACU balance. |
List the agents, then run one by its type. The agent id is the type field under data.agents[] — pass that as {type}. Reading name, or the top-level agents without the data envelope, yields undefined and a 404.
# 1) list agents — note the "type" field on each
curl -H "Authorization: Bearer vx_live_..." https://www.veryxjnn.com/api/public/v1/agents
# → { "success": true, "data": { "agents": [
# { "type": "cost_finance_agent", "name": "Cost & Finance Agent", "acu_per_run": 15 }, ... ] } }
# 2) run that agent by its "type" (not its name)
curl -X POST https://www.veryxjnn.com/api/public/v1/agents/cost_finance_agent/run \
-H "Authorization: Bearer vx_live_..." -H "Content-Type: application/json" \
-d '{"input":{}}'read:projectsRead projects & portfoliosread:tasksRead schedule tasksread:risksRead the risk registerread:agentsList the AI agent cataloguerun:agentsRun AI agents (consumes ACU)read:usageRead API usage & ACU balanceread:financeRead commitments, client invoices, ledger & cash-gapwrite:projectsCreate & update projectswrite:risksCreate & update riskswrite:tasksCreate & update schedule taskswrite:costsPost costs to the ledgerwrite:commitmentsCreate commitments & record supplier invoices/paymentswrite:invoicesIssue client invoices & record client paymentsrun:agents) consume prepaid ACU at the agent’s published rate; an empty balance returns HTTP 402.Machine-readable contract: /api/public/v1/openapi.json — import it into Postman or generate an SDK.
Connect your systems to the OS
Request your workspace