Amazon Mechanical Turk Api Quick Reference Card

Amazon Mechanical Turk Version 2008-05-09

Quick Reference Card Parameter types are strings unless otherwise noted. All parameters that contain “Id” require a valid ID. All parameters that contain “seconds” are of type non‐negative integer. Boolean values are “true” or “false.” All operations use the Operation parameter. Parentheses contain either constraints or data types. “DG” stands for the Amazon Mechanical Turk Service Developer Guide API Reference.

Operation

Required Parameters

Optional Parameters

Ap proveAssig nment Assig nQualification

AssignmentId QualificationTypeId WorkerId

RequesterFeedback IntegerValue (Integer) SendNotification (Boolean)

BlockWorker

Reason WorkerId

ChangeHITTyp eOfHIT

HITId HITTypeId

CreateHIT

AssignmentDurationIn Seconds (if HITTypeId is not given) Description (if HITTypeId is not given)

AutoApprovalDelayI nSeco nds Keywords MaxAssignments (positive Integer)

HITTypeId LifetimeInSeconds Question ( QuestionForm | ExternalQuestion )

QualificationRequir ement RequesterAnnotation

(Qualification)

Reward (if no HITTypeId given) Title (if no HITTypeId given) CreateQualificationT ype

Description Name QualificationTypeStat us

(Active | Inactive)

AnswerKey (AnswerKey) AutoGranted (Boolean) AutoGrantedValue (Integer) Keywords RetryDelayInSeconds Test (QuestionForm) TestDurationInSeconds

Disab leHIT Disp oseHIT Disp oseQualificationTyp e ExtendHIT ForceExp ireHIT GetAccountBalance GetAssignmentsForHI T

HITId HITId QualificationTypeId HITId MaxAssignmentsIncrement (positive

ExpirationIncrementIn Secon ds Integer)

HITId -HITId

-AssignmentStatus (Approved | Rejected | Submitted) PageNumber (positive Integer) PageSize (positive Integer) SortProperty (AcceptTime | AssignmentStatus SubmitTime)

|

SortDirection (Ascending | Descending) AssignmentId HITId PageNumber (positive Integer)

GetBonusPayments

PageSize (positive Integer) GetFileUpload URL

AssignmentId QuestionIdentifier

GetHIT GetHITsForQualific ati onT yp e

HITId QualificationTypeId

GetQualificationsFor Qualific ati onT yp e

QualificationTypeId

GetQualificationReq uests

PageNumber (positive Integer) PageSize (positive Integer) PageNumber (positive Integer) PageSize (positive Integer) Status (Granted | Revoked) PageNumber (positive Integer) PageSize (positive Integer) QualificationTypeId SortProperty (QualificationTyp eId | SubmitTime) SortDirection (Ascending | Descending)

GetQualificationScore

QualificationTypeId SubjectId

GetQualificationTyp e GetRequesterStatis tic

QualificationTypeId Statistic (see DG) TimePeriod (LifeToDate | OneDay | SevenDays | ThirtyDays)

Count (positive

Integer)

Revised 8/25/08

Operation

Required Parameters

GetReviewab leHITs

Optional Parameters HITTypeId PageNumber (positive Integer) PageSize (positive Integer) SortProperty (QualificationTyp eId | SubmitTime) SortDirection (Ascending | Descending) Status (Reviewable | Reviewing)

GetWorkerAccep t Limi t

LimitGroupId LimitGroupType (HIT Type | Default)

GrantBonus

AssignmentId BonusAmount (Price) Reason WorkId

GrantQualification Help

QualificationRequestId About (operation or response group name) HelpType (Operation | ResponseGroup)

NotifyWorkers

MessageText Subject WorkerId

Reg isterHITType

AssignmentDurationIn Seconds Descriptio Reward

IntegerValue

AutoApprovalDelayI nSeco nds Keywords QualificationRequir ement (Qualification)

Title RejectAssig nment

AssignmentId

RequesterFeedback

RejectQualificationReq uest RevokeQualification

QualificationRequestId QualificationTypeId SubjectId

Reason Reason

SearchHITs

PageNumber (positive Integer) PageSize (positive Integer) SortProperty (QualificationTyp eId

| SubmitTime)

SortDirection (Ascending | Descending) SearchQualificationTyp es

MustBeRequestable (Boolean)

MustBeOwnedByCal ler (Boolean) PageNumber (positive Integer) PageSize (positive Integer) Query SortProperty (QualificationTyp eId | SubmitTime) SortDirection (Ascending | Descending)

Send TestEventNotific ati on

Notification (Notification) TestEventType (see DG)

SetHITAsReviewing

HITId

Revert (Boolean)

SetHITTyp eNotifica tion

HITTypeId

Active (Boolean) Notification (Notification)

SetWorkerAccep tLi mit

LimitGroupId (when LimitGroupType is HIT Type) LimitGroupType (HIT Type | Default) MaxWorkerAcceptLimit

(positive

Integer)

Unb lockWorker Up d ateQualificationScore

WorkerId IntegerValue QualificationTypeId SubjectId

Reason

Up d ateQualificationTyp e

QualificationTypeId

AnswerKey (AnswerKey) AutoGranted (Boolean) AutoGrantedValue (Integer) Description QualificationTypeStat us RetryDelayInSeconds Test (QuestionForm) TestDurationInSeconds

(Active | Inactive)