API Reference

Quick Links:

Ingest Data

Upload Video

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/upload/video

Upload a video file to a batch for processing.

Upload Image

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/upload/image

Upload a single image to a batch for processing.

Bulk Upload Images

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/bulk-upload/image-files

Upload multiple images to a batch in a single request.

Check Batch Status

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/count

Get the count of items in a batch.

Check Shard Upload Details

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/shards

Get details about shard uploads within a batch.

Start a Job

POST /batch-processing/v1/external/{workspace}/jobs/{job_id}

Start a batch processing job.

Monitor Job Progress

Get Job Status

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}

Get the current status of a batch processing job.

List Job Stages

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}/stages

List all stages for a batch processing job.

List Stage Tasks

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}/stages/{stage_id}/tasks

List tasks within a specific job stage.

Export Results

List Output Parts

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/parts

List output parts for a completed batch.

List Download URLs

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/list

Get download URLs for batch output files.

Webhook Notifications

Instead of polling for status, you can use webhooks to get notified when ingestion or processing completes. See CLI Usage for webhook configuration and payload formats.