Amazon Web Services, Inc.

Amazon Mechanical Turk

Amazon Mechanical Turk API Reference

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Mechanical Turk API Reference

Endpoints 39

  • POSTAccept qualification request/#X-Amz-Target=MTurkRequesterServiceV20170117.AcceptQualificationRequestThe AcceptQualificationRequest operation approves a Worker's request for a Qualification. Only the owner of the Qualification type can grant a Qualification…
  • POSTApprove assignment/#X-Amz-Target=MTurkRequesterServiceV20170117.ApproveAssignmentThe ApproveAssignment operation approves the results of a completed assignment. Approving an assignment initiates two payments from the Requester's Amazon.com…
  • POSTAssociate qualification with worker/#X-Amz-Target=MTurkRequesterServiceV20170117.AssociateQualificationWithWorkerThe AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a…
  • POSTCreate additional assignments for hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateAdditionalAssignmentsForHITThe CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments,…
  • POSTCreate hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateHITThe CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical…
  • POSTCreate hIT type/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateHITTypeThe CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you…
  • POSTCreate hIT with hIT type/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateHITWithHITTypeThe CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation. This is…
  • POSTCreate qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateQualificationTypeThe CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.
  • POSTCreate worker block/#X-Amz-Target=MTurkRequesterServiceV20170117.CreateWorkerBlockThe CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality…
  • POSTDelete hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.DeleteHITThe DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it. You can only dispose of HITs…
  • POSTDelete qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.DeleteQualificationTypeThe DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type. This operation does not…
  • POSTDelete worker block/#X-Amz-Target=MTurkRequesterServiceV20170117.DeleteWorkerBlockThe DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock…
  • POSTDisassociate qualification from worker/#X-Amz-Target=MTurkRequesterServiceV20170117.DisassociateQualificationFromWorkerThe DisassociateQualificationFromWorker revokes a previously granted Qualification from a user. You can provide a text message explaining why the…
  • POSTGet account balance/#X-Amz-Target=MTurkRequesterServiceV20170117.GetAccountBalanceThe GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. Alternatively, this…
  • POSTGet assignment/#X-Amz-Target=MTurkRequesterServiceV20170117.GetAssignmentThe GetAssignment operation retrieves the details of the specified Assignment.
  • POSTGet file upload uRL/#X-Amz-Target=MTurkRequesterServiceV20170117.GetFileUploadURLThe GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a…
  • POSTGet hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.GetHITThe GetHIT operation retrieves the details of the specified HIT.
  • POSTGet qualification score/#X-Amz-Target=MTurkRequesterServiceV20170117.GetQualificationScoreThe GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type. To get a Worker's Qualification, you must…
  • POSTGet qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.GetQualificationTypeThe GetQualificationType operation retrieves information about a Qualification type using its ID.
  • POSTList assignments for hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.ListAssignmentsForHITThe ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get…
  • POSTList bonus payments/#X-Amz-Target=MTurkRequesterServiceV20170117.ListBonusPaymentsThe ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.
  • POSTList hI ts/#X-Amz-Target=MTurkRequesterServiceV20170117.ListHITsThe ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the…
  • POSTList hI ts for qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.ListHITsForQualificationTypeThe ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs…
  • POSTList qualification requests/#X-Amz-Target=MTurkRequesterServiceV20170117.ListQualificationRequestsThe ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls…
  • POSTList qualification types/#X-Amz-Target=MTurkRequesterServiceV20170117.ListQualificationTypesThe ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.
  • POSTList review policy results for hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHITThe ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given…
  • POSTList reviewable hI ts/#X-Amz-Target=MTurkRequesterServiceV20170117.ListReviewableHITsThe ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the…
  • POSTList worker blocks/#X-Amz-Target=MTurkRequesterServiceV20170117.ListWorkerBlocksThe ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.
  • POSTList workers with qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.ListWorkersWithQualificationTypeThe ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.
  • POSTNotify workers/#X-Amz-Target=MTurkRequesterServiceV20170117.NotifyWorkersThe NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same…
  • POSTReject assignment/#X-Amz-Target=MTurkRequesterServiceV20170117.RejectAssignmentThe RejectAssignment operation rejects the results of a completed assignment. You can include an optional feedback message with the rejection, which the…
  • POSTReject qualification request/#X-Amz-Target=MTurkRequesterServiceV20170117.RejectQualificationRequestThe RejectQualificationRequest operation rejects a user's request for a Qualification. You can provide a text message explaining why the request was rejected.…
  • POSTSend bonus/#X-Amz-Target=MTurkRequesterServiceV20170117.SendBonusThe SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when…
  • POSTSend test event notification/#X-Amz-Target=MTurkRequesterServiceV20170117.SendTestEventNotificationThe SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided…
  • POSTUpdate expiration for hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.UpdateExpirationForHITThe UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately…
  • POSTUpdate hIT review status/#X-Amz-Target=MTurkRequesterServiceV20170117.UpdateHITReviewStatusThe UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can…
  • POSTUpdate hIT type of hIT/#X-Amz-Target=MTurkRequesterServiceV20170117.UpdateHITTypeOfHITThe UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties…
  • POSTUpdate notification settings/#X-Amz-Target=MTurkRequesterServiceV20170117.UpdateNotificationSettingsThe UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings…
  • POSTUpdate qualification type/#X-Amz-Target=MTurkRequesterServiceV20170117.UpdateQualificationTypeThe UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.…

API details

Base URL
https://mturk-requester.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
39 operations on 39 pathsPOST 39
Description format
AWS Smithy model, API version 2017-01-17

How to test the Amazon Mechanical Turk in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Mechanical Turk collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept qualification request” (POST /#X-Amz-Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Mechanical Turk?

Amazon Mechanical Turk API Reference It is listed under Developer tools and has 39 endpoints.

Who publishes the Amazon Mechanical Turk?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Mechanical Turk?

Requests go to https://mturk-requester.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Mechanical Turk?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Mechanical Turk have?

39 operations on 39 paths (39 POST).

Is forking the Amazon Mechanical Turk free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.