Basic Parameters

USERID

Your USERID which can be found in the portal on the API Access page.

KEY

Your API KEY which can be found in the portal on the API Access page.

WebHook

The URL the task output data should be delivered to via a POST request.

CustomID

An optional custom ID you can set to identify this task.

Budget

The amount of money, in cents, the tasker will receive for successfully completing the task.

Title

The title of the task.

Description

A detailed description of the task.

EstimatedDuration

The estimated amount of time, in seconds, it should take a tasker to complete the task.

ExpiresAfter

The amount of time, in seconds, before the task is set to expire.

Keywords

An array of keywords relevant to the task.

AutoApproveAfter

The amount of time, in seconds, before the task is automatically approved.

Instructions

Detailed instructions for how to complete the task.

Example Open Task Request

If you're loading a remote script, be sure to set the Access-Control-Allow-Origin header to *. This is required

JSON

{
  "USERID": "YOUR_USERID_HERE",
  "KEY": "YOUR_API_KEY_HERE",
  "WebHook": "https://www.yourwebsite.com/processWebHook/something.php?id=whaterurlencodeddatayouwant",
  "CustomID": "YOUR_CUSTOMID_HERE",
  "Budget": "100",
  "Title": "Example Request",
  "Description": "This is an example task request.",
  "EstimatedDuration": 600,
  "ExpiresAfter": 86400,
  "Keywords": [
    "Keyword1",
    "Keyword2"
  ], 
  "AutoApproveAfter": 86400,
  "Instructions": "This is where you say what needs to be done.",
 "Content": {
      "0":{
        "Width": 8,
        "Type": "pdf",
        "Options": {
          "url": ""
        }
      },
      "1":{
        "Width": 8,
        "Type": "text",
        "Options": {
          "value": "Go to google and search for the 'Country Villas Homeowners Association' and enter the url."
        }
      }
 },
  "Questions": {
    "0": {
      "Width": 4,
      "Body": [
        {
          "parent": 0,
          "label": "What type of dwelling is listed on the document?",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 0,
          "step": 0,
          "subType": 0,
          "subType_data": {
            "Single Family Home": "0",
            "Town Home": "1",
            "Condo": "2"
          }
        },
        {
          "parent": "1",
          "label": "",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 1,
          "step": 1,
          "subType": "0",
          "subType_data": {
            "a": "1",
            "b": "2",
            "c": "3"
          }
        }
      ]
    },
    "1": {
      "Width": 4,
      "Body": [
        {
          "parent": "2",
          "label": "Could You Located The Homeowner Association URL?",
          "type": "SELECT",
          "width": "12",
		  "offset": "0",
          "element_id": 2,
          "step": 0,
          "subType": 0,
          "subType_data": {
            "No": "0",
            "Yes": "1"
          }
        }
      ]
    }
  }
}

Atom Task