API and agents
Authentication, conventions, the public API, webhooks and the agent front door.
Getting started
What the API covers, your first request, conventions and the reference.
Authentication
API keys, OAuth 2.1 connected apps, agent credentials and scopes.
AI agents
Connect Claude, ChatGPT or any MCP-capable assistant.
Webhooks
Get told when records change.
- API reference
The interactive reference for the documented operations, the index of every operation a key can call, and the OpenAPI document to download.
- Configure daily route arrangements through the API
Set explicit start and finish choices, private bases and daily overrides without changing appointments.
- Errors and how to recover
Every error a Nova integration or AI agent can get, the exact response it arrives in, and what to do next.
- Find the operation to call
Use the operation index to find any of Nova's roughly 3,200 callable operations and the exact permission each one needs, not just the documented starter set.
- How records are identified
Every Nova record has an opaque uid for software and a record number for people. Which to send, which to show, and the few identifiers that are not records.
- Make your first API request
Create an API key in Nova, call the API from the command line, read the response, and know what to try next. Ten minutes, no OAuth.
- Nova API overview
What the Nova API covers, the three ways software connects, how records are addressed, and where to start as an integration or an AI agent.
- Paging, filtering, errors and rate limits
The conventions every Nova operation follows for lists, record identity, updates, the error envelope, idempotency and rate limits.
- Review account details from a conversation through the API
Analyze a bounded text sample, check for existing customer records and explicitly confirm an atomic account capture.
- Understand route road calculations
Interpret road times, missing calculations and spending limits without treating unknown driving as zero.
- Authenticate with OAuth 2.1 or an API key
Get a token as a connected app (OAuth 2.1 with PKCE), as an AI teammate (client credentials) or as an integration (API key), and send it on every call.
- Choose between an API key, a connected app and an AI teammate
Three ways into one API: an API key for your own software, an OAuth connected app for a product other people use, and an AI teammate for AI that works on its own. Which to pick and why.
- Rate limits, daily caps and other limits on a credential
The per-minute limits, the optional daily cap on changes, working hours, address allowlists, expiry and branch limits that can apply to an API key, connected app or AI teammate.
- Scopes reference
Every scope a key, connected app or agent can hold, what each one allows, and the rules that keep a scope from ever granting more than the person or role behind it.
- Connect an AI agent through MCP
Connect Claude, ChatGPT or any MCP-capable assistant to Nova, as a person or as an AI teammate, and what it can reach once connected.
- Handle an action that waits for a person's approval
When an action needs a person's approval, the call answers approval_required. Why it happens, what the response holds, how long it lasts, and how to finish the action once approved.
- Run software as an AI teammate
Sign in as an organization's AI teammate with client credentials, and what working as one means for your calls — its roles, grant, working hours, daily cap, customer disclosure and activity.
- The tools an assistant gets over MCP
The tools, resources and prompts Nova's MCP server offers, including find_operations and call_nova_operation, which reach everything a connection's grant covers.
- Receive webhooks when records change
Subscribe an endpoint to Nova events, verify the signature on every delivery, and replay what you missed.