REST API
A practical API surface for video ingestion, artifacts, evidence, and Ask Video.
REST, dashboard, durable artifacts, and the live remote MCP endpoint are available for Public Beta evaluation.
Endpoint map
| Method | Path | Current beta behavior |
|---|---|---|
| POST | /api/videos/add | Create a video source record from URL, HLS stream, or uploaded recording metadata. |
| GET | /api/product/videos | List tenant video records in the dashboard workspace. |
| POST | /api/product/videos/{video_id}/execute | Run bounded CPU-first processing and materialize artifacts. |
| GET | /api/product/videos/{video_id}/scene-graph | Return structured World-State objects, events, zones, confidence, and evidence refs. |
| GET | /api/product/videos/{video_id}/timeline | Return event timeline and semantic refresh markers. |
| GET | /api/product/videos/{video_id}/evidence-view | Return traceable evidence spans and review notes. |
| POST | /api/product/videos/{video_id}/ask | Ask a question with evidence-required guardrails. |
| GET | /api/product/videos/{video_id}/cost | Return cost.json, detector mode, duration, fallback, and retention. |
| GET | /api/product/billing/state | Return sandbox plan limits and current beta usage state. |
| POST | /api/public/onboarding/demo-video | Create a synthetic demo workspace for a new account. |
Copyable flow
curl -X POST https://api.ayneye.com/api/videos/add \
-H "Authorization: Bearer $AYNEYE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/video.mp4","title":"loading-zone sample"}'
curl -X POST https://api.ayneye.com/api/product/videos/$VIDEO_ID/execute \
-H "Authorization: Bearer $AYNEYE_API_KEY"
curl https://api.ayneye.com/api/product/videos/$VIDEO_ID/scene-graph \
-H "Authorization: Bearer $AYNEYE_API_KEY"