Signup Login

Create an Asynchronous Job

API Method: job_create

Description

Create a job to be used with an asynchronous T2A method.

This is a free method.

Mandatory Parameters

Name Description
api_key Use your API key. Note that this method may only be invoked server-side.

Optional Parameters

Name Description
client You can optionally include an identifier for your final client or user. This is logged in your usage log and you will be able to view your usage statistics by client.

Returned Values

The XML response is contained within a <job_create_res> element.

Name Description
status Returns ok if the operation has succeeded, or error if an error has occurred; Returns the error_code for error details.
error_code Returns the error code when the status is error. See below for error codes.
t2a_version_number The current API version number.
job_id The unique ID used to identify your job. Note that this key is alphanumeric, plus the _ and - characters.

Error Codes

See the common error codes. There are no errors which are specific to this method.

Example XML Response


<?xml version="1.0"?>
<job_create_res>
  <mode>normal</mode>
  <status>ok</status>
  <t2a_version_number>2.7.4.0</t2a_version_number>
  <job_id>lZGW0z6YBwbdeFcsI0fyzfIRL3egaNI5FWUaYdxHIBt-</job_id>
</job_create_res>