Amazon Mechanical Turk
API Reference (API Version 2017-01-17)

CreateHITWithHITType

Description

The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.

CreateHIT also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.

Note

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.

Request Syntax

{ "HITTypeId": String, "Question": String, "HITLayoutId": String, "HITLayoutParameters": HITLayoutParameterList, "LifetimeInSeconds": Integer, "MaxAssignments": Integer, "AssignmentReviewPolicy": ReviewPolicy, "HITReviewPolicy": ReviewPolicy, "RequesterAnnotation": String, "UniqueRequestToken": String }

Request Parameters

The request accepts the following data in JSON format:

Name Description Required

HITTypeId

The HIT type ID.

Type: String

Yes

Question

The data the person completing the HIT uses to produce the results. You can learn more about the various ways of specifying this field here.

Type: String

Constraints: The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace. Either a Question parameter or a HITLayoutId parameter must be provided.

No

HITLayoutId

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters. For more information, see here.

Type: String

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

No

HITLayoutParameters

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Type: HITLayoutParameterList

No

LifetimeInSeconds

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Type: Integer

Yes

MaxAssignments

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Type: Integer

Yes

AssignmentReviewPolicy

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Type: ReviewPolicy

No

HITReviewPolicy

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Type: ReviewPolicy

No

RequesterAnnotation

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT. The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester. The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Type: String

No

UniqueRequestToken

A unique identifier for this request. Allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Type: String

Constraints: must not be longer than 64 characters in length. It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

No

Response Elements

A successful request for the CreateHIT operation returns HIT object containing the newly created HIT data.

Example

The following example shows how to use the CreateHITWithHITType operation:

Sample Request

The following example creates a simple HIT. The Question parameter takes a block of XML data as its value.

POST / HTTP/1.1 Host: mturk-requester.us-east-1.amazonaws.com Content-Length: <PayloadSizeBytes> X-Amz-Date: <Date> { HITTypeId:"T100CN9P324W00EXAMPLE", Question:[XML question data], LifetimeInSeconds:604800 }

Sample Response

The following is an example response:

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { HITId:"789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE", HITTypeId:"789RVWYBAZW00EXAMPLE951RVWYBAZW00EXAMPLE" }