Menu
User Guide / API Reference

API Reference

The SalmonVision API provides programmatic access to all platform features.

Base URL

https://api.salmonvision.org/v1

Authentication

All requests require a Bearer token:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.salmonvision.org/v1/projects

Generate API keys under Settings → API Keys in the dashboard.

Endpoints

Projects

Method Endpoint Description
GET /projects List all projects
GET /projects/{id} Get project details
POST /projects Create a new project
PUT /projects/{id} Update a project
DELETE /projects/{id} Delete a project

Detections

Method Endpoint Description
GET /projects/{id}/detections List detections
GET /detections/{id} Get detection detail
PATCH /detections/{id} Update detection (review)

Cameras

Method Endpoint Description
GET /projects/{id}/cameras List cameras
POST /projects/{id}/cameras Add a camera
DELETE /cameras/{id} Remove a camera

Export

Method Endpoint Description
POST /projects/{id}/export Trigger data export
GET /exports/{id} Check export status / download

Pagination

List endpoints support pagination:

GET /projects/{id}/detections?page=1&per_page=50

Response includes pagination metadata:

{
  "data": [...],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 1234,
    "total_pages": 25
  }
}

Rate Limits

  • Free tier: 100 requests/minute
  • Pro tier: 1,000 requests/minute
  • Enterprise: Unlimited

Previous: Data Export | Next: Custom Models

← Previous Data Export ← Previous Login ← Previous Project page ← Previous Webapp ← Previous Workflow Next → Custom Models