> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cargovision.app/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cargovision.app/_mcp/server. # API Reference ## API Docs - Cargovision REST API > user/auth/email [Verify email registration](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/verify-email-registration.md) - Cargovision REST API > user/auth/email [Check email verification status](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/check-email-verification-status.md) - Cargovision REST API > user/auth/email [Register a verified email](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/register-a-verified-email.md) - Cargovision REST API > user/auth/email [Login a user](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/login-a-user.md) - Cargovision REST API > user/auth/email [Reset forgotten password](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/reset-forgotten-password.md) - Cargovision REST API > user/auth/email [Change forgotten password after the email verified](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth-email/change-forgotten-password-after-the-email-verified.md) - Cargovision REST API > user/auth [Refresh authentication token](https://docs.cargovision.app/api-reference/cargovision-rest-api/user-auth/refresh-authentication-token.md) - Cargovision REST API > containers [Identify container via OCR scan](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/identify-container-via-ocr-scan.md) - Cargovision REST API > containers [Real-time OCR detection via WebSocket stream](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/real-time-ocr-detection-via-web-socket-stream.md) - Cargovision REST API > containers [Finalize streaming OCR](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/finalize-streaming-ocr.md) - Cargovision REST API > containers [Manually set container number](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/manually-set-container-number.md) - Cargovision REST API > containers [Validate and attach manifest](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/validate-and-attach-manifest.md) - Cargovision REST API > containers [Manually enter manifest data](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/manually-enter-manifest-data.md) - Cargovision REST API > containers [Run defect detection scan](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/run-defect-detection-scan.md) - Cargovision REST API > containers [Real-time defect detection via WebSocket stream](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/real-time-defect-detection-via-web-socket-stream.md) - Cargovision REST API > containers [Finalize streaming defect scan](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/finalize-streaming-defect-scan.md) - Cargovision REST API > containers [Run illegal goods detection](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/run-illegal-goods-detection.md) - Cargovision REST API > containers [Real-time illegal goods detection via WebSocket stream](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/real-time-illegal-goods-detection-via-web-socket-stream.md) - Cargovision REST API > containers [Finalize streaming illegal scan](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/finalize-streaming-illegal-scan.md) - Cargovision REST API > containers [Run category verification](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/run-category-verification.md) - Cargovision REST API > containers [Real-time item category classification via WebSocket stream](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/real-time-item-category-classification-via-web-socket-stream.md) - Cargovision REST API > containers [Finalize streaming category scan](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/finalize-streaming-category-scan.md) - Cargovision REST API > containers [Get dashboard statistics](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-dashboard-statistics.md) - Cargovision REST API > containers [Get trend data](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-trend-data.md) - Cargovision REST API > containers [Get container by number](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-container-by-number.md) - Cargovision REST API > containers [List user's containers](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/list-users-containers.md) - Cargovision REST API > containers [Get container by ID](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-container-by-id.md) - Cargovision REST API > containers [Generate inspection report](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/generate-inspection-report.md) - Cargovision REST API > containers [Get container timeline](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-container-timeline.md) - Cargovision REST API > containers [Submit manual review](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/submit-manual-review.md) - Cargovision REST API > containers [Get all evidence for container](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/get-all-evidence-for-container.md) - Cargovision REST API > containers [Upload evidence photos for container](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/upload-evidence-photos-for-container.md) - Cargovision REST API > containers [Delete evidence photo](https://docs.cargovision.app/api-reference/cargovision-rest-api/containers/delete-evidence-photo.md) - Cargovision REST API > devices [Register device for push notifications](https://docs.cargovision.app/api-reference/cargovision-rest-api/devices/register-device-for-push-notifications.md) - Cargovision REST API > devices [Unregister device](https://docs.cargovision.app/api-reference/cargovision-rest-api/devices/unregister-device.md) - Cargovision REST API > devices [List user's devices](https://docs.cargovision.app/api-reference/cargovision-rest-api/devices/list-users-devices.md) - Cargovision REST API > edge-device [Push container OCR identification from edge device](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-container-ocr-identification-from-edge-device.md) - Cargovision REST API > edge-device [Push defect scan from edge device](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-defect-scan-from-edge-device.md) - Cargovision REST API > edge-device [Push illegal-goods scan from edge device](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-illegal-goods-scan-from-edge-device.md) - Cargovision REST API > edge-device [Push category scan from edge device](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-category-scan-from-edge-device.md) - Cargovision REST API > edge-device [Push tracking data from edge device](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-tracking-data-from-edge-device.md) - Cargovision REST API > edge-device [Push batch tracking data](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-batch-tracking-data.md) - Cargovision REST API > edge-device [Push stream status event](https://docs.cargovision.app/api-reference/cargovision-rest-api/edge-device/push-stream-status-event.md) - Cargovision REST API > tracking [List tracking events](https://docs.cargovision.app/api-reference/cargovision-rest-api/tracking/list-tracking-events.md) - Cargovision REST API > tracking [List stream statuses](https://docs.cargovision.app/api-reference/cargovision-rest-api/tracking/list-stream-statuses.md) - Cargovision REST API > tracking [Get tracking statistics](https://docs.cargovision.app/api-reference/cargovision-rest-api/tracking/get-tracking-statistics.md) - Cargovision REST API > tracking [Get camera trackings](https://docs.cargovision.app/api-reference/cargovision-rest-api/tracking/get-camera-trackings.md) - Cargovision REST API > manifests [List manifests](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/list-manifests.md) - Cargovision REST API > manifests [Create standalone manifest](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/create-standalone-manifest.md) - Cargovision REST API > manifests [Get manifest by container number](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/get-manifest-by-container-number.md) - Cargovision REST API > manifests [Get manifest by ID](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/get-manifest-by-id.md) - Cargovision REST API > manifests [Update manifest](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/update-manifest.md) - Cargovision REST API > manifests [Delete manifest](https://docs.cargovision.app/api-reference/cargovision-rest-api/manifests/delete-manifest.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.cargovision.app/openapi.json) - [OpenAPI YAML](https://docs.cargovision.app/openapi.yaml) > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cargovision.app/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cargovision.app/_mcp/server. # API reference The reference is generated from the Cargovision OpenAPI specification. Each endpoint page lists its parameters, request and response schemas, and authentication scheme, and includes an API Explorer for sending live requests. ## Base URL ``` https://api.cargovision.app/v1 ``` The health probes `/health` and `/ready` are the only routes outside `/v1`. ## Authentication | Scheme | Header | Used by | | ------------ | ----------------------------- | ----------------------------------------- | | `bearerAuth` | `Authorization: Bearer ` | Operator, supervisor, and admin endpoints | | `apiKeyAuth` | `X-API-Key: ` | Edge ingestion endpoints | Browsers can authenticate with the `token` session cookie instead of the bearer header. See [Authentication](/authentication). ## Endpoint groups | Group | Paths | Auth | | --------------------- | ------------------------------ | --------------------------------- | | User auth | `/v1/user/auth/*` | Public, except refresh | | Containers and scans | `/v1/containers/*` | JWT | | Evidence | `/v1/containers/{id}/evidence` | JWT | | Manifests | `/v1/manifests/*` | JWT | | Devices (mobile push) | `/v1/devices/*` | JWT | | Edge device | `/v1/edge/containers/*` | API key | | Tracking | `/v1/tracking-data/*` | API key for writes, JWT for reads | Responses use the envelopes described in [Responses and errors](/responses-and-errors).