API Reference

Overview

The Octo API is a JSON REST API. The base URL in local development is http://localhost:8080.

Response envelope

Every response uses the same envelope:

{
  "statusCode": 200,
  "message": "OK",
  "data": { /* object or array */ }
}

• statusCode — mirrors the HTTP status.
• message — a short human-readable summary, or the error reason.
• data — the result (object or array), or null on error.

Errors

Errors use standard HTTP status codes and the same envelope:

• 400 — invalid request (bad input).
• 401 — missing or invalid credentials.
• 404 — not found, or not authorized for this resource.
• 409 — conflict (e.g. a reused idempotency key).

Next: Authentication.