API Workflow

Working with Mechanical Turk Workers

The typical use case for SentimentIt is to assign comparisons to Mechanical Turk workers. For information on obtaining comparisons from other workers, see the section below.

  1. Get an authentication token. Include the auth token on all subsequent requests.
  2. Create Documents.
  3. Create Comparisons either one at a time or in batches
  4. Create HITs for individual comparisons or a batch
  5. Download processed HITs for a batch
  6. If necessary, re-post expired HITs

Working with Custom Workers

We also provide support for working with a custom workforce. The process is largely similar to the one above, with a few exceptions.

  1. Get an authentication token. Include the auth token on all subsequent requests.
  2. Create Documents.
  3. Create Comparisons either one at a time or in batches
  4. Prepare tasks for workers (this is analogous to preparing HITs for Turk Workers) using either comparison IDs or the batch ID. This will return URLs for each comparison (if you want to assign specific workers to specific tasks) and a URL for the batch. Using the batch URL, workers will work through a queue of comparisons until the batch is complete.
  5. Download processed comparisons for your batch