npm install mturk-apivar mturk = require('mturk-api');
var config = {
access : 'ACCESS_KEY_GOES_HERE',
secret : 'SECRET_KEY_GOES_HERE',
sandbox: true
}
//DEPRECATION NOTICE: please use mturk.createClient() instead
//the connect method will no longer be supported in v3.0
mturk.connect(config).then(function(api){
api.req('GetAccountBalance').then(function(res){
//Do something
}).catch(console.error);
}).catch(console.error);
// Returns an API client; uses REST via HTTPS
var api = mturk.createClient(config);
//Example operation, no params
api.req('GetAccountBalance').then(function(response){
//Do something
}, function(error){
//Handle error
});
//Example operation, with params
api.req('SearchHITs', { PageSize: 100, PageNumber: 2 }).then(function(response){
//Do something
}, function(error){
//Handle error
});
//Amazon Mechanical Turk limits the velocity of requests.
//Normally, if you exceed the limit you will receive a
//503 Service Unavailable error. As of v2.0, our interface
//automatically throttles your requests to 3 per second.
var pageNum = 1;
var ITERATIONS = 30;
for(var i=0; i < ITERATIONS; i++){
//These requests will be queued and executed at a rate of 3 per second
api.req('SearchHITs', { PageSize: 100, PageNumber: pageNum }).then(function(response){
var currPage = Number(response.SearchHITsResponse.SearchHITsResult[0].PageNumber);
if(currPage === ITERATIONS){ done(); }
}).catch(done);
pageNum++;
}
| Operation | Required Parameters | Unit test |
|---|---|---|
| ApproveAssignment | { AssignmentId:String } | |
| ApproveRejectedAssignment | { AssignmentId:String } | |
| AssignQualification | { QualificationTypeId:String, WorkerId:String } | ✓ |
| BlockWorker | { WorkerId:String, Reason:String } | ✓ |
| ChangeHITTypeOfHIT | { HITId:String, HITTypeId:String} | |
| CreateHIT | { Title:String, Description:String, AssignmentDurationInSeconds:Number, LifetimeInSeconds:Number } OR {HITTypeId:String, LifetimeInSeconds:Number } | |
| CreateQualificationType | { Name:String, Description:String, QualificationTypeStatus:String } | ✓ |
| DisableHIT | { HITId:String } | |
| DisposeHIT | { HITId:String } | |
| DisposeQualificationType | {QualificationTypeId:String} | ✓ |
| ExtendHIT | { HITId:String } | |
| ForceExpireHIT | { HITId:String } | ✓ |
| GetAccountBalance | None | ✓ |
| GetAssignment | { AssignmentId:String } | |
| GetAssignmentsForHIT | { HITId:String } | |
| GetBlockedWorkers | None | ✓ |
| GetBonusPayments | { HITId:String } OR { AssignmentId:String } | |
| GetFileUploadURL | { AssignmentId:String, QuestionIdentifier:String } | |
| GetHIT | { HITId:String } | ✓ |
| GetHITsForQualificationType | { QualificationTypeId:String } | |
| GetQualificationsForQualificationType | { QualificationTypeId:String } | |
| GetQualificationRequests | None | |
| GetQualificationScore | { QualificationTypeId:String, SubjectId:String} | |
| GetQualificationType | { QualificationTypeId:String } | |
| GetRequesterStatistic | { Statistic:String, TimePeriod:String } | |
| GetRequesterWorkerStatistic | {Statistic:String, WorkerId:String, TimePeriod:String } | |
| GetReviewableHITs | None | |
| GetReviewResultsForHIT | { HITId:String } | |
| GrantBonus | { WorkerId:String, AssignmentId:String, BonusAmount:Object, Reason:String } | |
| GrantQualification | { QualificationRequestId:String } | |
| NotifyWorkers | { Subject:String, MessageText:String, WorkerId:Array} | |
| RegisterHITType | { Title:String, Description:String, Reward:Object, AssignmentDurationInSeconds:Number } | |
| RejectAssignment | { AssignmentId:String } | |
| RejectQualificationRequest | { QualificationRequestId:String } | |
| RevokeQualification | { Subject:String, QualificationTypeId:String, Reason:String } | |
| SearchHITs | None | ✓ |
| SearchQualificationTypes | { MustBeRequestable:Boolean } | |
| SendTestEventNotification | { Notification:Object, TestEventType:Object } | ✓ |
| SetHITAsReviewing | { HITId:String } | |
| SetHITTypeNotification | { HITTypeId:String, Notification:Object, } | |
| UnblockWorker | { WorkerId:String, } | ✓ |
| UpdateQualificationScore | { QualificationTypeId:String, SubjectId:String, IntegerValue:Number } | |
| UpdateQualificationType | { QualificationTypeId:String } |
- Question String
assign the a_girl_photo_url to an image url value.
var _questionString = '<?xml version="1.0"?>\n<HTMLQuestion xmlns="http://mechanicalturk.amazonaws.com/AWSMechanicalTurkDataSchemas/2011-11-11/HTMLQuestion.xsd">\n <HTMLContent><![CDATA[<!DOCTYPE html><html><head><title>HIT</title><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><script type=\'text/javascript\' src=\'https://s3.amazonaws.com/mturk-public/externalHIT_v1.js\'></script></head><body><form name="mturk_form" method="post" id="mturk_form" action="https://www.mturk.com/mturk/externalSubmit"><input type="hidden" value="" name="assignmentId" id="assignmentId" /><!-- Bootstrap v3.0.3 -->\r\n<link href="https://s3.amazonaws.com/mturk-public/bs30/css/bootstrap.min.css" rel="stylesheet" />\r\n<section class="container" id="Other" style="margin-bottom:15px; padding: 10px 10px; font-family: Verdana, Geneva, sans-serif; color:#333333; font-size:0.9em;">\r\n<div class="row col-xs-12 col-md-12"><!-- Instructions -->\r\n<div class="panel panel-primary">\r\n<div class="panel-heading"><strong> IS the gril in the photo hot? + '</strong></div>\r\n</div>\r\n<!-- Content Body -->\r\n\r\n<section>\r\n<fieldset>\r\n<img alt="" class="image-fixed" src="'
+ a_girl_photo_url
+ '" /><br><div class="left">\r\n<div class="radio"><label><input name="answer" type="radio" value="Yes" />YES</label></div>\r\n</div>\r\n\r\n<div class="right">\r\n<div class="radio"><input name="answer" type="radio" value="NO" /> NO </div>\r\n</div>\r\n</fieldset>\r\n</section>\r\n<!-- End Content Body --></div>\r\n</section>\r\n<!-- close container -->\r\n<style type="text/css">fieldset {\r\n padding: 10px;\r\n background: #fbfbfb;\r\n border-radius: 5px;\r\n margin-bottom: 5px;\r\n}\r\n\r\n.left {\r\n float: left;\r\n display: block;\r\n padding: 20px;\r\n width: 49%;\r\n}\r\n\r\n.right {\r\n float: right;\r\n display: block;\r\n padding: 20px;\r\n width: 49%\r\n}\r\n\r\n.image-fixed {\r\n max-width: 512px;\r\n max-height: 200px;\r\n}\r\n</style>\r\n<p class="text-center"><input type="submit" id="submitButton" class="btn btn-primary" value="Submit" /></p></form><script language="Javascript">turkSetAssignmentID();</script></body></html>]]></HTMLContent>\n <FrameHeight>600</FrameHeight>\n</HTMLQuestion>';';- HITOption
var _HITOption = {
Title: "Is the girl hot? (WARNING: This HIT may contain adult content. Worker discretion is advised.)"
, Keywords: "photo"
, Description: "Say Yes or No to the question."
, Reward: {Amount: '0.01', CurrencyCode: 'USD', FormattedPrice: '$0.01'}
, AssignmentDurationInSeconds: 180 // in 3 minutes
, AutoApprovalDelayInSeconds: 28800 // auto approve the worker's anwser and pay to him/her
, MaxAssignments: 100 // 100 worker
, QualificationRequirement: [
{
QualificationTypeId: '000000000000000000L0', // HIT Approval Rate %
Comparator: 'GreaterThan',
IntegerValue: [60],
RequiredToPreview: true
},
{
QualificationTypeId: '000000000000000000S0', // HIT Reject Rate %
Comparator: 'LessThan',
IntegerValue: [10],
RequiredToPreview: true
},
{
QualificationTypeId: '00000000000000000060', // Adult Content Qualification
Comparator: 'EqualTo',
IntegerValue: [1],
RequiredToPreview: true
}]
, Question: _questionString,
, LifetimeInSeconds: 86400 * 3 // 3 days
};- Create the HIT with the option
var CreateHIT = function (HITOption, callback) {
mturk.connect(config).then(function (api) {
api.req('CreateHIT', _HITOption).then(function (response) {
callback(null, response.HIT[0]);
}, function (err) {
callback(err);
});
}).catch(console.error);
};MIT © Jose Barrios
Banner derived from Cosmin Cuciureanu's BrainUP