API v3.0

API v3.0 is a significant step toward a unified and flexible API.

Full backward compatibility is maintained across API versions. These docs describe the latest version by default, but previous API versions remain supported. If you need documentation for an older API version, contact support.

Base URL

terminal

https://vision.gaard.ai/api

Authentication

All API requests must include a valid token in the Authorization header using the Bearer scheme:

Authorization: Bearer <your-api-token>

API tokens are created in the Gaard app at Settings > Platform > Integrations. Each token is scoped to a tenant and optionally to a specific flow.

Requests with a missing or invalid token receive a 403 response:

{
  "success": false,
  "error": "no access to current endpoint, make sure you are using correct API key"
}

Sections

• Endpoints: classify, retrieve results, download annotated video, delete
• Response structure: full response schema and field descriptions
• Classification result: detailed result type, status constants, and examples
• Webhooks: configure callback delivery, inspect the payload, and understand webhook latency
• Metadata: optional metadata.json format for video submissions
• Risk, labels, and scores: how scores map to risk levels and labels
• Labels API: list labels, post feedback labels on classifications