POST/project

Create A New Project

Create a project to specify your language, quality and others settings before you start posting your translations.

Parameters

Body JSON

token:

required

string

You need access token to call this endpoint. You can retrieve it by calling /auth/login endpoint. Tokens are expired in 24 hours for security reasons.

quality:

required

string

Choose from basic,pro,expert

source_language_id:

required

string

The source language of the translation project. It is a two-letter ISO 639-1 language code. Ex: tr,en,de

target_language_ids:

required

array of string

The target language(s) of the translation project. You can send the target_language_ids parameter either as array or comma separated string. Ex; target_language_ids[]=de&target_language_ids[]=fr or target_language_ids=de,fr,tr

title:

string

You can specify a project title if you wish to use later for your own purposes

note:

string

Notes are directly passed to the translators who will do your job. So if you want to write a general instruction you can pass it with this parameter.

extras:

string

Extras parameter is a custom parameter for your own usage. You can send any data, we send you back with the project when it is ready. It is limited to 1kb

auto_start:

enum

This parameter is used for deciding when the translation jobs should be started. If it is 'on' whenever you post a translation, it is automatically started to be translated. If you send it as 'off', you need to call /project/start endpoint to start manually. Default value is off for auto_start

callback_url:

string

Callback urls are important but not required. Whenever a translation job is finished we let you know by using the callback urls that you are provided. We simply post the finished jobs to your callback_url. If you don't specify it, you need to check your job statuses yourself to see whether they are finished or not

project_url:

string

If your project has a url ( a website or store url for an application ) you can specify it, so we can understand what kind of purposes the translations will serve. This may help to improve your translation's quality.

expertise_id:

string

If you choose expert quality level, we highly recommend you send us needed expertise area code for it. You can check supported expertise areas from /util/expertises endpoint

Example Response


{
  "status": "success",
  "code": 200,
  "project": {
    "quality": "basic",
    "source_language_id": "tr",
    "target_language_ids": [
      "en",
      "fr",
      "it"
    ],
    "title": "My New Project",
    "expertise_id": "basic",
    "extras": "",
    "note": "",
    "callback_url": "",
    "product_url": "",
    "auto_start": "off",
    "status": "new",
    "created_at": {
      "sec": 1478199918,
      "usec": 828000
    },
    "updated_at": {
      "sec": 1478199918,
      "usec": 828000
    },
    "job_count": 0,
    "doc_count": 0,
    "price": 0,
    "word_count": 0,
    "vat": 0,
    "code": "PRJ_8d7d",
    "currency": "TRY",
    "ppw": 0.53,
    "id": "581b8a6e8ead0e90328b4570"
  },
  "msg": "Created new project"
}