Download OpenAPI specification:
Public API for asynchronous image and video analysis.
Accepts a binary video file and enqueues it for analysis.
Returns 202 Accepted with a Location header to poll for results.
| Max-Processing-Time | integer >= 0 Upper-bound on server-side processing time in seconds. If the job exceeds this limit the server cancels it and returns an error. If set to 0, an infinite time is accepted. |
The binary video to be processed
{- "job_id": "vid_12345"
}Accepts a JSON payload containing one or more base64-encoded images.
Returns 202 Accepted with a Location header to poll the batch status
and per-item results.
Notes:
images[].data_base64 field must be raw base64 (no data URI prefix).failed.| Max-Processing-Time | integer >= 0 Upper-bound on server-side processing time in seconds. If the job exceeds this limit the server cancels it and returns an error. If set to 0, an infinite time is accepted. |
required | Array of objects non-empty One or more images to analyze |
{- "images": [
- {
- "external_id": "abc",
- "data_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
}, - {
- "external_id": "def",
- "data_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
}
]
}{- "job_id": "img_batch_abc"
}| job_id required | string Example: vid_12345 |
{- "job_id": "vid_12345",
- "status": "finished",
- "result": {
- "raw_scenes": [
- {
- "start_seconds": 0,
- "end_seconds": 5.2
}, - {
- "start_seconds": 5.2,
- "end_seconds": 10.7
}
], - "frame_activity_diffs": [
- 0.01,
- 0.15,
- 0.08
], - "sections": [
- {
- "section_tag": "intro",
- "time_segments": [
- {
- "start_seconds": 0,
- "end_seconds": 3
}
], - "thumbnail_timestamp": 1.2,
- "confidence": 0.91,
- "is_critical": false,
- "relative_activity": 0.2
}, - {
- "section_tag": "demo",
- "time_segments": [
- {
- "start_seconds": 3,
- "end_seconds": 5.2
}
], - "thumbnail_timestamp": 4.1,
- "confidence": 0.88,
- "is_critical": false,
- "relative_activity": 0.5
}
], - "ocr_results": [
- {
- "language_code": "en",
- "full_text": "No dogs off leash",
- "time_segments": [
- {
- "start_seconds": 3,
- "end_seconds": 5.2
}
]
}
], - "person_constellation_scenes": [
- {
- "time_segment": {
- "start_seconds": 3,
- "end_seconds": 5.2
}, - "person_ids": [
- {
- "age": 29,
- "gender": "female",
- "face_embedding": [
- 0.11,
- -0.02,
- 0.33
]
}, - {
- "gender": "unidentified",
- "face_embedding": [
- 0.05,
- 0.07,
- -0.12
]
}
]
}, - {
- "time_segment": {
- "start_seconds": 5.2,
- "end_seconds": 10.7
}, - "person_ids": [ ]
}
]
}
}| job_id required | string Example: img_batch_abc |
{- "job_id": "img_batch_abc",
- "status": "finished",
- "items": [
- {
- "external_id": "101",
- "result": {
- "tags": [
- {
- "tag": "cat",
- "probability": 0.92,
- "is_critical": false
}, - {
- "tag": "indoor",
- "probability": 0.76
}
], - "person_ids": [
- {
- "age": 4,
- "gender": "unidentified",
- "face_embedding": [
- 0.01,
- 0.02,
- 0.03
]
}
], - "ocr_results": [
- {
- "language_code": "en",
- "full_text": "Kitchen"
}
]
}
}, - {
- "external_id": "102",
- "result": {
- "tags": [
- {
- "tag": "dog",
- "probability": 0.88
}, - {
- "tag": "park",
- "probability": 0.61,
- "is_critical": false
}
], - "person_ids": [ ],
- "ocr_results": [
- {
- "full_text": "No dogs off leash"
}
]
}
}
]
}Returns the observed processing latency per media unit:
video: latency per second of video time.image: latency per individual image in a batch.| mediaType required | string Enum: "video" "image" Media type whose latency is requested |
{- "media_type": "image",
- "unit": "image",
- "latency_ms_per_unit": 120
}