Create HIT

POST /v1/create-hit

See original API description on Amazon Mechanical Turk.

Headers

Content-Type string Required

Values are application/x-amz-json-1.1 or application/json. Default value is application/json.

Body

Title string Required
Description string Required
Question string
HITLayoutId string
HITLayoutParameters array[object]
Hide HITLayoutParameters attributes Show HITLayoutParameters attributes array[object]
- Name string Required
- Value string Required
Reward string Required
AssignmentDurationInSeconds integer Required
LifetimeInSeconds integer Required
Keywords string
MaxAssignments integer Required
AutoApprovalDelayInSeconds integer
QualificationRequirements array[object]
Hide QualificationRequirements attributes Show QualificationRequirements attributes array[object]
- QualificationTypeId string Required
- Comparator string Required
- IntegerValues array[integer]
- LocaleValues array[object]
  Hide LocaleValues attributes Show LocaleValues attributes array[object]
  
  Country string Required
  
  Subdivision string
- RequiredToPreview boolean Deprecated
- ActionsGuarded string
AssignmentReviewPolicy object
Hide AssignmentReviewPolicy attributes Show AssignmentReviewPolicy attributes object
- PolicyName string Required
- Parameters array[object] Required
  Hide Parameters attributes Show Parameters attributes array[object]
  
  Key string Required
  
  Values array[string] Required
  
  MapEntries array[object] Required
  
  Hide MapEntries attributes Show MapEntries attributes array[object]
  
  Key string Required
  
  Values array[string] Required
HITReviewPolicy object
Hide HITReviewPolicy attributes Show HITReviewPolicy attributes object
- PolicyName string Required
- Parameters array[object] Required
  Hide Parameters attributes Show Parameters attributes array[object]
  
  Key string Required
  
  Values array[string] Required
  
  MapEntries array[object] Required
  
  Hide MapEntries attributes Show MapEntries attributes array[object]
  
  Key string Required
  
  Values array[string] Required
RequesterAnnotation string
UniqueRequestToken string

Responses

200

OK
Hide response attribute Show response attribute object
- HIT object Required
  
  Hide HIT attributes Show HIT attributes object
  
  HITId string
  
  HITTypeId string
  
  HITGroupId string
  
  HITLayoutId string
  
  CreationTime string(date-time)
  
  Title string
  
  Description string
  
  Keywords string
  
  HITStatus string
  
  Values are Assignable, Unassignable, Reviewable, Reviewing, or Disposed.
  
  Reward string Required
  
  LifetimeInSeconds integer
  
  AssignmentDurationInSeconds integer
  
  MaxAssignments integer
  
  Default value is 1.
  
  AutoApprovalDelayInSeconds integer
  
  Expiration string(date-time)
  
  QualificationRequirements array[object]
  
  Hide QualificationRequirements attributes Show QualificationRequirements attributes array[object]
  
  QualificationTypeId string Required
  
  Comparator string Required
  
  IntegerValues array[integer]
  
  LocaleValues array[object]
  
  Hide LocaleValues attributes Show LocaleValues attributes array[object]
  
  Country string Required
  
  Subdivision string
  
  RequiredToPreview boolean Deprecated
  
  ActionsGuarded string
  
  Question string
  
  RequesterAnnotation string
  
  HITReviewStatus string
  
  Values are NotReviewed, MarkedForReview, ReviewedAppropriate, or ReviewedInappropriate.
  
  NumberOfAssignmentsPending integer
  
  Minimum value is 0.
  
  NumberOfAssignmentsAvailable integer
  
  Minimum value is 0.
  
  NumberOfAssignmentsCompleted integer
  
  Minimum value is 0.
404

Resource not found

POST /v1/create-hit

curl \
 -X POST https://yourcrowd.ai.moda/api/v1/create-hit \
 -H "Content-Type: application/json" \
 -d '{"Title":"Title example","Description":"Description example","Question":"Question example","HITLayoutId":"HITLayoutId example","HITLayoutParameters":[{"Name":"Name example","Value":"Value example"}],"Reward":"Reward example","AssignmentDurationInSeconds":1,"LifetimeInSeconds":1,"Keywords":"Keywords example","MaxAssignments":1,"AutoApprovalDelayInSeconds":1,"QualificationRequirements":[{"QualificationTypeId":"QualificationTypeId example","Comparator":"Comparator example","IntegerValues":[1],"LocaleValues":[{"Country":"Country example","Subdivision":"Subdivision example"}],"RequiredToPreview":true,"ActionsGuarded":"ActionsGuarded example"}],"AssignmentReviewPolicy":{"PolicyName":"PolicyName example","Parameters":[{"Key":"Key example","Values":["Value example"],"MapEntries":[{"Key":"Key example","Values":["Value example"]}]}]},"HITReviewPolicy":{"PolicyName":"PolicyName example","Parameters":[{"Key":"Key example","Values":["Value example"],"MapEntries":[{"Key":"Key example","Values":["Value example"]}]}]},"RequesterAnnotation":"RequesterAnnotation example","UniqueRequestToken":"UniqueRequestToken example"}'

Request example

# Headers
Content-Type: application/json

# Payload
{
  "Title": "Title example",
  "Description": "Description example",
  "Question": "Question example",
  "HITLayoutId": "HITLayoutId example",
  "HITLayoutParameters": [
    {
      "Name": "Name example",
      "Value": "Value example"
    }
  ],
  "Reward": "Reward example",
  "AssignmentDurationInSeconds": 1,
  "LifetimeInSeconds": 1,
  "Keywords": "Keywords example",
  "MaxAssignments": 1,
  "AutoApprovalDelayInSeconds": 1,
  "QualificationRequirements": [
    {
      "QualificationTypeId": "QualificationTypeId example",
      "Comparator": "Comparator example",
      "IntegerValues": [
        1
      ],
      "LocaleValues": [
        {
          "Country": "Country example",
          "Subdivision": "Subdivision example"
        }
      ],
      "RequiredToPreview": true,
      "ActionsGuarded": "ActionsGuarded example"
    }
  ],
  "AssignmentReviewPolicy": {
    "PolicyName": "PolicyName example",
    "Parameters": [
      {
        "Key": "Key example",
        "Values": [
          "Value example"
        ],
        "MapEntries": [
          {
            "Key": "Key example",
            "Values": [
              "Value example"
            ]
          }
        ]
      }
    ]
  },
  "HITReviewPolicy": {
    "PolicyName": "PolicyName example",
    "Parameters": [
      {
        "Key": "Key example",
        "Values": [
          "Value example"
        ],
        "MapEntries": [
          {
            "Key": "Key example",
            "Values": [
              "Value example"
            ]
          }
        ]
      }
    ]
  },
  "RequesterAnnotation": "RequesterAnnotation example",
  "UniqueRequestToken": "UniqueRequestToken example"
}

Request examples

# Headers
Content-Type: application/json

# Payload
{
  "Title": "Title example",
  "Description": "Description example",
  "Question": "Question example",
  "HITLayoutId": "HITLayoutId example",
  "HITLayoutParameters": [
    {
      "Name": "Name example",
      "Value": "Value example"
    }
  ],
  "Reward": "Reward example",
  "AssignmentDurationInSeconds": 1,
  "LifetimeInSeconds": 1,
  "Keywords": "Keywords example",
  "MaxAssignments": 1,
  "AutoApprovalDelayInSeconds": 1,
  "QualificationRequirements": [
    {
      "QualificationTypeId": "QualificationTypeId example",
      "Comparator": "Comparator example",
      "IntegerValues": [
        1
      ],
      "LocaleValues": [
        {
          "Country": "Country example",
          "Subdivision": "Subdivision example"
        }
      ],
      "RequiredToPreview": true,
      "ActionsGuarded": "ActionsGuarded example"
    }
  ],
  "AssignmentReviewPolicy": {
    "PolicyName": "PolicyName example",
    "Parameters": [
      {
        "Key": "Key example",
        "Values": [
          "Value example"
        ],
        "MapEntries": [
          {
            "Key": "Key example",
            "Values": [
              "Value example"
            ]
          }
        ]
      }
    ]
  },
  "HITReviewPolicy": {
    "PolicyName": "PolicyName example",
    "Parameters": [
      {
        "Key": "Key example",
        "Values": [
          "Value example"
        ],
        "MapEntries": [
          {
            "Key": "Key example",
            "Values": [
              "Value example"
            ]
          }
        ]
      }
    ]
  },
  "RequesterAnnotation": "RequesterAnnotation example",
  "UniqueRequestToken": "UniqueRequestToken example"
}

Response examples (200)

{
  "HIT": {
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "HITTypeId": "AZ2256EXAM",
    "HITGroupId": "AZ2256EXAM",
    "HITLayoutId": "AZ2256EXAM",
    "CreationTime": "2012-01-31T23:59:59Z",
    "Title": "Example HIT",
    "Description": "Example HIT",
    "Keywords": "Example HIT",
    "HITStatus": "Assignable",
    "Reward": "25.01",
    "LifetimeInSeconds": 3600,
    "AssignmentDurationInSeconds": 3600,
    "MaxAssignments": 1,
    "AutoApprovalDelayInSeconds": 3600,
    "Expiration": "2012-01-31T23:59:59Z",
    "QualificationRequirements": [
      {
        "QualificationTypeId": "QualificationTypeId example",
        "Comparator": "Comparator example",
        "IntegerValues": [
          1
        ],
        "LocaleValues": [
          {
            "Country": "Country example",
            "Subdivision": "Subdivision example"
          }
        ],
        "RequiredToPreview": true,
        "ActionsGuarded": "ActionsGuarded example"
      }
    ],
    "Question": "string",
    "RequesterAnnotation": "Example HIT",
    "HITReviewStatus": "NotReviewed",
    "NumberOfAssignmentsPending": 1,
    "NumberOfAssignmentsAvailable": 1,
    "NumberOfAssignmentsCompleted": 1
  }
}

Response examples (200)

{
  "HIT": {
    "HITId": "123RVWYBAZW00EXAMPLE444RVWYBAZW01EXAMPLE",
    "HITTypeId": "AZ2256EXAM",
    "HITGroupId": "AZ2256EXAM",
    "HITLayoutId": "AZ2256EXAM",
    "CreationTime": "2012-01-31T23:59:59Z",
    "Title": "Example HIT",
    "Description": "Example HIT",
    "Keywords": "Example HIT",
    "HITStatus": "Assignable",
    "Reward": "25.01",
    "LifetimeInSeconds": 3600,
    "AssignmentDurationInSeconds": 3600,
    "MaxAssignments": 1,
    "AutoApprovalDelayInSeconds": 3600,
    "Expiration": "2012-01-31T23:59:59Z",
    "QualificationRequirements": [
      {
        "QualificationTypeId": "QualificationTypeId example",
        "Comparator": "Comparator example",
        "IntegerValues": [
          1
        ],
        "LocaleValues": [
          {
            "Country": "Country example",
            "Subdivision": "Subdivision example"
          }
        ],
        "RequiredToPreview": true,
        "ActionsGuarded": "ActionsGuarded example"
      }
    ],
    "Question": "string",
    "RequesterAnnotation": "Example HIT",
    "HITReviewStatus": "NotReviewed",
    "NumberOfAssignmentsPending": 1,
    "NumberOfAssignmentsAvailable": 1,
    "NumberOfAssignmentsCompleted": 1
  }
}