Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspect.inc/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Analyze API lets you query visual content in your assets. It uses Moondream to answer questions and to locate objects within images or at specific timestamps in videos. Prerequisites:
  • An asset_id that belongs to your index
  • For videos, a video_timestamp (in seconds) when asking about a specific frame

​
Ask about an image or video frame

curl -X POST "$ASPECT_URL/analyze/ask" \
  -H "Authorization: Bearer $ASPECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "<ASSET_UUID>",
    "query": "What color is the car?",
    "video_timestamp": 12.5
  }'
Response contains an answer and optionally reasoning.

​
Get coordinates of a point-of-interest

curl -X POST "$ASPECT_URL/analyze/point" \
  -H "Authorization: Bearer $ASPECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "<ASSET_UUID>",
    "query": "Where is the stop sign?",
    "video_timestamp": 12.5
  }'
Returns an array of { x, y } pixel coordinates.

​
Get bounding boxes for objects

curl -X POST "$ASPECT_URL/analyze/box" \
  -H "Authorization: Bearer $ASPECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "asset_id": "<ASSET_UUID>",
    "query": "Find all people",
    "video_timestamp": 12.5
  }'
Returns an array of bounding boxes: { x_min, y_min, x_max, y_max }.

​
Access control and errors

  • You can only analyze assets in your own indexes. Sample indexes may be publicly viewable when marked ready.
  • For video assets, video_timestamp is required.
  • 404 if asset or index cannot be found; 403 if you do not have access.
See API reference for exact request and response schemas.