nOps Public API

The nOps Public API (api.nops.io) provides programmatic access to cost data, cost allocation, budgets, reports, recommendations, feed, scheduled prompts, and notifications.

Base URL

https://api.nops.io/v1 Use the API Reference pages in the sidebar to explore and test endpoints interactively. Download the spec: openapi.json (also at /openapi.json on help.nops.io). For local preview, run npm run dev from public-docs (not plain npx mintlify dev) so /openapi.json is served with your latest generated spec. This starts a proxy on localhost:3001 (override with DOCS_DEV_PORT) that serves the spec at /openapi.json and forwards everything else to the underlying Mintlify dev server. If you are contributing to nOps and change a Public API route, regenerate the spec from the clara app directory before previewing docs:

npm run generate:public-api-openapi

Requirements

The Public API is included with nOps Inform + Operate — the same plans that power Explorer, Budgets, Reports, and Feed in the app. You will also need:

An API key with the permissions required for each endpoint
Keys are created in Settings → Security → API Keys

Quick start

curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.nops.io/v1/recommendations

See Authentication, Rate limits, and Errors for details.

Getting started

API Reference

Developers

nOps Public API

Base URL

Requirements

Quick start

​nOps Public API

​Base URL

​Requirements

​Quick start

nOps Public API

Base URL

Requirements

Quick start