Oversight
Using the APIs
Oversight API Workflow
This workflow describes the process of uploading a media asset and creating a task request.
NOTE: Skip Step 1 and Step 2 if using Mounted Buckets Mounted buckets currently only support image assets. For video assets, please use Step 1 and Step 2.
Step 1: Upload Media ( Not needed if using Mounted Buckets )
Use the Upload Media API to initiate the upload process.
Provide:
configuration_id: This should have been passed to you.
The API returns a response containing:
media_upload_url: URL for uploading the actual media content.
media_key: Unique identifier associated with the uploaded media.
Step 2: Upload Media Data ( Not needed if using Mounted Buckets )
Prepare the media file for upload.
Use the media_upload_url from the previous step to make a PUT request with the media data.
Chose Binary type in body and upload your media file.
Step 3: Create Task Request
Use the Create Task API to create a request.
Provide:
media_key: The media key obtained in Step 1.
(Optional) bucket_id: Provide the bucket credential Id , if using Mounted Buckets.
configuration_id: The same ID used for media upload.
(Optional) callback_url: URL for receiving notifications about task completion.
The API returns a response containing:
task_id: Unique identifier for the created task request.
Success:
The media is uploaded to CloudFactory.
A task is created and media is available in hasty project ready for annotation.
You can use the task_id to track the progress or retrieve results
Last updated
