Skip to main content

Create project

This operation creates a translation project in LanguageWire Platform, which is the container for the files (documents) to get translated by our experts.

Important

Before creating your project, check the list of prerequisites.


This is the basic flow you need to follow when creating your project:

  1. Create your translation project with the information needed.
  2. Add the files you want to get translated.
  3. Start the project so files can be sent to our Platform experts for translation.
  4. Download the already translated file.

Curious about the full project creation flow? Learn more in our guides here.

Tip

Use already created templates to speed the project creation up.

  • Templates are pre-configured in our Platform by LanguageWire Project Managers based on your needs.
  • Benefit: These help you save time when setting your project up.

πŸ“§Contact us for more information.


Request Body β€” REQUIRED

The project creation payload

title string

Add a title to your project that can be easily recognised.

  • You are allowed to use a maximum of 500 characters for your title.
  • When using a project template, the title from the template will be used unless you provide a new one. In that case, the provided one will overwrite the template title.
briefing string

Summarise what is your project about (in general terms).
Example:This is a project to get a medical article translated from German into French.

briefingForExperts string

Add any information that helps our experts to accurately translate your content.
Example:This is a medical article, please keep in mind that some treatment names should not be translated as they are referred by generic brand names.

purchaseOrderNumber string
deadline date-time

Set the date when this project should be finished.
- If the selected deadline is too tight, we will contact you before starting the project.
- If not specified, or if set to null, LanguageWire will assign a deadline.
πŸ’‘ Tip:Use the ISO 8601 format as Coordinated Universal Time (UTC) for the dates.

templateId int32

⚠️ If you are using a template you don't need to specify the following fields: title, serviceId, translationMemoryId, translationMemorySetId, termBaseId, invoicingAccountId, or workareaId

  • You can remove the values or set them to null.
  • Any value added to those fields will be used instead of the value set in the project template except the serviceId which cannot be overridden.
serviceId int32

This is the ID of the service you need for your translation project. Example:Localisation, SEO, translation and validation,etc.
Refer to the GET /services call for more information.

translationMemoryId int32

This is the ID of the translation memory you need for your translation project.
Refer to the GET /translation-memories call for more information.

translationMemorySetId int32

This is the ID of the translation memory set you need for your translation project.
TM sets always have preference over single TMs.
Refer to the GET /translation-memory-sets call for more information.

useTranslationMemory boolean

Indicates if a translation memory must be used or not for your project.
If set to true and no translation memory ID is explicitly provided or configured in a provided project template, the platform will attempt to use the primary translation memory set at the company level.
If set to false, the project will not use a TM regardless of what is specified using the translationMemoryID setting, the translation memory configured in the project templated used or the company's primary translation memory.

termBaseId int32

This is the ID of the term base you need for your translation project.
Refer to the GET /term-bases call for more information.

invoicingAccountId int32

This is the ID of the LanguageWire Platform account you want us to use for this project invoice.
⚠️ Make sure you use an invoicing account ID that is up to date, otherwise the project might be cancelled.
Refer to the GET /invoicing-accounts call for more information.

userId int32

This is the ID of the user you need for your translation project.
Refer to the GET /users call for more information.

workAreaId int32

This is the ID of the specialisation field that describes your translation project. Example:Science - Genetics.
πŸ’‘ Tip:Specify this field, according to the nature of the to-be-translated contents, so we ensure our experts in the matter work on them. Refer to the GET /workareas call for more information.

externalId string

This is the identifier you choose for your project.
πŸ’‘ Tip:Choose an identifier that matches your system records, this way you will be able to track it easily. We recommend to use a universally unique identifier (UUIDv4 or GUID).

metadata object

This is the metadata that has been added to the project.

Responses
201

Project created

Schema β€” OPTIONAL
id integer β€” OPTIONAL
externalId string β€” OPTIONAL
title string β€” OPTIONAL
briefing string β€” OPTIONAL
briefingForExperts string β€” OPTIONAL
purchaseOrderNumber string β€” OPTIONAL
deadline date-time β€” OPTIONAL
creationDate date-time β€” OPTIONAL
finishedAt date-time β€” OPTIONAL
templateId integer β€” OPTIONAL
serviceId integer β€” OPTIONAL
translationMemoryId integer β€” OPTIONAL
translationMemorySetId integer β€” OPTIONAL
translationMemorySetVersion integer β€” OPTIONAL
useTranslationMemory boolean β€” OPTIONAL
termBaseId integer β€” OPTIONAL
invoicingAccountId integer β€” OPTIONAL
userId integer β€” OPTIONAL
workAreaId integer β€” OPTIONAL
status string β€” OPTIONAL
platformLink string β€” OPTIONAL
referenceFiles string[] β€” OPTIONAL
files object[] β€” OPTIONAL
sourceFileId string β€” OPTIONAL
sourceFileName string β€” OPTIONAL
sourceLanguage string β€” OPTIONAL
translations object[] β€” OPTIONAL
id integer β€” OPTIONAL
fileId string β€” OPTIONAL
targetLanguage string β€” OPTIONAL
status string β€” OPTIONAL
translationFileName string β€” OPTIONAL
translationFileLink string β€” OPTIONAL
metadata object β€” OPTIONAL

This is the metadata that has been added to the project.

400

Bad request

Schema β€” OPTIONAL
object[]
code string
message string
hints string