LogoLogo
SolutionsResourcesHelp Docs
  • Getting Started
    • Setup Guide
    • Authentication
    • Webhook
    • Oversight Mounting Buckets
    • Rate Limiting
    • Uploading Media Assets
  • CloudFactory Public API
    • API Reference
      • WorkStream Performance
        • Secure Upload
        • Throughput
        • Quality
      • Oversight
        • Upload Media
        • Submit Task
        • Task Status
    • Snowflake Secure Data Sharing
    • Fivetran and Amazon S3 Data Sharing
Powered by GitBook

Contact Us

  • Book a Meeting

Company

  • About Us
  • Partnerships
  • Compliance
  • Data Security
On this page
  • Oversight API Workflow
  • Success:

Was this helpful?

Export as PDF
  1. CloudFactory Public API
  2. API Reference

Oversight

Using the APIs

PreviousQualityNextUpload Media

Last updated 4 months ago

Was this helpful?

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 )

  1. Use the Upload Media API to initiate the upload process.

  2. Provide:

    • configuration_id: This should have been passed to you.

  3. 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 )

  1. Prepare the media file for upload.

  2. Use the media_upload_url from the previous step to make a PUT request with the media data.

  3. Choose Binary type in body and upload your media file.

Step 3: Create Task Request

  1. Use the Create Task API to create a request.

  2. 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.

  3. 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

Ensure the proper content-type is set for your media file in the request header.

Read More

Submit Task

Upload Media

Task Status