API Reference.
The AppVet REST API uses JSON for request and response bodies.
All endpoints require a valid API key via the
Authorization: Bearer header. The base URL is
https://appvet.dev.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/scan | Create a new scan |
| GET | /v1/scan/:id | Get scan status and progress |
| GET | /v1/report/:id | Get the full scan report |
| GET | /v1/scans | List your scans with pagination |
| GET | /v1/usage | Get current usage and quota |
Conventions
- All responses return JSON with a top-level object.
-
Errors include a
codestring and a human-readableerrormessage. See Error Codes. -
Timestamps are ISO 8601 in UTC (e.g.,
2026-03-30T12:00:00Z). -
IDs use prefixed strings:
scan_for scans,rpt_for reports. -
Pagination uses
limitandoffsetquery parameters.
Authentication
Every request must include your API key in the Authorization
header. See Authentication for details.
Authorization: Bearer avk_live_your_key_here