API v1

Endpoint reference

EndpointWhat it does
GET /api/v1/statusNo auth. Service status.
GET /api/v1/meAccount and plan.
GET /api/v1/usageMinute credit, expiry, session minutes used.
GET /api/v1/devicesRegistered agents. Empty until hub registration exists.
GET /api/v1/devices/{id}One device, or 404.
POST /api/v1/sessionsCreate a session request / invite for a device. The person at the device must still accept. Never starts unattended control.
GET /api/v1/sessionsList sessions for the account.
GET /api/v1/sessions/{id}One session.
POST /api/v1/sessions/{id}/endEnd a session.
POST /api/v1/ai/assistReturns 501 not_implemented until the AI plugin backend is wired. Does not call any paid AI.

Base URL: https://consoleai.com.au/api/v1. JSON. Request id in X-Request-Id. Errors: {"error":{"code","message"}}.

Where the hub is not live yet, list endpoints return an empty list or 501 rather than fake data. Paid sessions need prepaid credit (or a Team / Business plan).

curl

curl -s https://consoleai.com.au/api/v1/me -H "Authorization: Bearer $CAI_KEY" 

Python

import requests
r = requests.get("https://consoleai.com.au/api/v1/usage",
                 headers={"Authorization": f"Bearer {key}"})
print(r.json())

JavaScript

const r = await fetch("https://consoleai.com.au/api/v1/status");
console.log(await r.json());