API Reference

This page documents the local AllvIa Core API from main/core/src/api_server.rs. It is an agent pipeline API, not the legacy SaaS-style /automations API.

Important: AllvIa Core API runs on your local machine. Default port is 5680, and there is no public cloud API base URL for these routes.

Base URL

http://127.0.0.1:5680

You can change the port with STEER_API_PORT.

Authentication

In production profile, set STEER_API_KEY and send one of the headers below.

Authorization: Bearer YOUR_STEER_API_KEY

X-API-Key: YOUR_STEER_API_KEY

For local development only, no-key mode can be enabled with STEER_API_ALLOW_NO_KEY=1.

Quick Check

GET /api/health

curl -H "X-API-Key: $STEER_API_KEY" http://127.0.0.1:5680/api/health
# ok

GET /api/status

{
  "cpu_usage": 3.1,
  "memory_used": 145,
  "memory_total": 16384
}

Core Endpoint Groups

Group	Main Endpoints	Description
Agent Pipeline	`POST /api/agent/intent`, `/plan`, `/execute`, `/verify`, `/approve`	Natural language request -> intent -> plan -> execution/verification
Goal	`POST /api/agent/goal`, `/goal/run`, `GET /api/agent/goal/current`	Asynchronous/synchronous goal execution
Recommendations	`GET /api/recommendations`, `POST /api/recommendations/:id/approve`	List/approve/reject/later/restore recommendations and metrics
Verification	`POST /api/verify/runtime`, `/visual`, `/semantic`, `/performance`	Runtime, visual, semantic, and performance checks
Ops/System	`GET /api/logs`, `/api/system/health`, `/api/system/runtime-info`	Operational status, logs, and runtime metadata
Sessions	`GET /api/sessions`, `GET\|DELETE /api/sessions/:id`, `POST /api/sessions/:id/resume`	Session lifecycle management

Agent Pipeline Example

POST /api/agent/intent

{ "text": "Analyze today's activity and recommend routines" }

POST /api/agent/plan

{ "session_id": "session_xxx" }

POST /api/agent/execute

{
  "plan_id": "plan_xxx",
  "profile": "strict"
}

Response (summary)

{
  "status": "success",
  "run_id": "plan_xxx_1730000000000",
  "planner_complete": true,
  "execution_complete": true,
  "business_complete": true,
  "logs": ["..."]
}

Error Codes

Status	Meaning
`200`	Success
`202`	Accepted for async processing (goal queue/running)
`400`	Bad request payload
`401`	Unauthorized (missing/mismatched API key)
`404`	Session/plan/resource not found
`409`	Execution lock conflict
`500`	Internal server error

The route source of truth is the router in main/core/src/api_server.rs. Track breaking changes in Releases.