VERYX Platform API

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.

Get a key

Authenticate

Send Authorization: Bearer vx_… (or the X-API-Key header) on every request.

Call the OS

Hit the endpoints below. Watch usage and ACU in your workspace.

Base URL & authentication

Base URL   /api/public/v1
Auth       Authorization: Bearer vx_live_xxx      (or)   X-API-Key: vx_live_xxx

curl -H "Authorization: Bearer vx_test_..." /api/public/v1/ping

Endpoints

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.

Scopes

read:projectsRead projects & portfolios

read:tasksRead schedule tasks

read:risksRead the risk register

read:agentsList the AI agent catalogue

run:agentsRun AI agents (consumes ACU)

read:usageRead API usage & ACU balance

Limits & pricing

· Each call is metered against your plan’s monthly API quota (see Business → API & Developers).
· Per-endpoint rate limiting protects the platform; exceed it and you get HTTP 429.
· Agent runs (run:agents) consume prepaid ACU at the agent’s published rate; an empty balance returns HTTP 402.
· Keys are environment-scoped (test / production) and can be revoked instantly.

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