API Reference
PremiumREST API for config sync and team management. Available on the Solo and Teams plans. A hosted AI endpoint is on the roadmap — see below.
All API endpoints are served from https://api.servonaut.dev/v1
Authentication
Servonaut uses OAuth 2.0 Device Flow for authentication. This flow is designed for CLI tools and devices that cannot open a browser.
Device flow steps
- Your CLI requests a device code from the
/oauth/device/codeendpoint. - The user opens the verification URL in their browser and enters the user code.
- The CLI polls
/oauth/tokenuntil the user approves. - On approval, the CLI receives a long-lived access token.
Using the access token
Include the token in all API requests as a Bearer token in the Authorization header.
Config Sync
Store and retrieve configuration snapshots from the Servonaut cloud.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1/config |
Get the current active config snapshot |
| GET | /v1/config/snapshots |
List all stored snapshots (paginated) |
| POST | /v1/config |
Push a new config snapshot |
| POST | /v1/config/restore/{id} |
Restore a specific snapshot |
Servonaut AI Coming soon
A hosted AI endpoint — log analysis, security review, cost review, and incident triage
through a single POST /v1/ai/chat — is the next major addition. Quota,
model routing, and tool-use via the CLI relay are all planned. Endpoints will be
documented here once they ship.
Teams
Team management endpoints are available on the Teams plan only.
| Method | Path | Description |
|---|---|---|
| GET | /v1/team |
Get your team details and members list |
| POST | /v1/team/members/invite |
Invite a new member by email |
| POST | /v1/team/members/{id}/role |
Update a member's role (admin, member, viewer) |
| DELETE | /v1/team/members/{id} |
Remove a team member |
| GET | /v1/team/audit-log |
Retrieve the team audit trail (paginated) |
Rate limits and quotas
| Plan | API requests | Config snapshots |
|---|---|---|
| Free | — | — |
| Solo | 1,000/hour | 30 |
| Teams | 5,000/hour per seat | Unlimited |
Servonaut AI quotas will be published here when the hosted AI endpoint ships.
Rate limit headers are returned on every response:
Error codes
| HTTP status | Error code | Description |
|---|---|---|
400 | invalid_request | Malformed request body or missing required fields |
401 | unauthorized | Missing or invalid access token |
403 | forbidden | Token does not have permission for this action |
404 | not_found | Resource does not exist |
429 | rate_limited | Rate limit exceeded. Retry after X-RateLimit-Reset |
500 | internal_error | Server error. Report to support |