Projects
Last updated
Was this helpful?
Last updated
Was this helpful?
Get a quote of a project given the provided parameters without actually creating it.
id
string
The unique identifier of the project.
ref
string
The reference identifying the project.
name
string
The name of the project.
activity_name
string
The activity of the project.
archived
boolean
Whether the project is archived or not.
status
string
created_at
string
updated_at
string
launched_at
string
completed_at
string
cached_documents_count
integer
The number of documents in a project.
language_from_code
string
language_to_code
string
level_name
string
pricing.total_cost_at_launch_time
integer
The cost of the project at launch time in credits.
total_word_count
integer
The number of words in the project.
progress
integer
Describe the progress in percent towards the project's completion.
category
string
platform_id
string
The unique UUID of the integration platform. Used to tell apart projects created via different integrations (Salesforce, Wordpress, etc.).
Creates a project and assign its document later or create a project with documents embedded along with the project's attributes.
A project can be created with the following options:
language_level
string
Required. premium or enterprise.
quality
boolean
Whether the project should be sent to quality control or not.
expertise
string
specific_attachment
boolean
Whether the project has documents with exotic file extensions such as .idml or .psd for example.
priority
boolean
Whether the project is urgent or not. A financial incentive will be shown to authors to ensure the project gets picked up faster.
uniq_author
boolean
Whether the project should be assigned to the same author for all its documents or not. Slower but with editorial continuity.
translation_memory
boolean
Whether translation memory analysis should be applied or not.
translation_diff
boolean
Whether translation diff pre-fill should be applied or not.
post_editing_machine_translation
boolean
Whether machine translation should be applied or not.
Warning: Some options such as translation_memory, translation_diff and post_editing_machine_translation require a project to have documents assigned to work properly. Enabling these options on a project without documents will result in an error.
Creates a new project from the given one. It copies the following attributes from the source project:
category
grammatical_person
keywording_requirements
language_from
language_level
language_to
name
project_briefing
same_author_must_do_entire_project
target_reader_groups
textmasters
vocabulary_type
work_template
This endpoint is asynchronous and instruct the API to queue the project to be launched as soon as possible. Trying to launch a project while an asynchronous operation is still running on it or its documents will result in an error.
Launches given project assuming your account has enough funds and all asynchronous operations have been run. Launching a project synchronously might result in HTTP timeouts depending on the its size and complexity.
Instruct the API that all documents have been created for this project and asynchronous operations should be started as soon as possible.
Since asynchronous operations such as translation_memory , translation_diff or post_editing_machine_translation should only be run on projects when all their documents have been created, this endpoint gives you the opportunity to tell TextMaster when you have created all documents for a project.
Note that you don't have to monitor and wait for asynchronous operations to be completed on each document before calling this endpoint. TextMaster takes care of queuing this request to be executed as soon as possible.
Only completed or cancelled projects can be archived.
You can use the to filter documents on a collection of criteria.
The status of the project. See the section.
Describes the time the project was created. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the project was last updated. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the project was launched. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
Describes the time the project was completed. This is a timestamp in format: YYYY-MM-DDTHH:MM:SSZ.
The source language code of the project. One of the language code returned by the endpoint.
The target language code of the project. One of the language code returned by the endpoint.
The level of the project. One of the level names returned by the endpoint.
The category identifier for the project. One of the category returned by the endpoint.
When setting the auto_launch option on a project, assuming your account's balance has enough funds, TextMaster will automatically attempt to launch the project as soon as all asynchronous operations have been completed, such as analysis for example.
Warning: Using the auto_launch option assumes your account has enough funds to launch the project. The project will remainin_creation otherwise and will need to be launched manually with the endpoint.
Create a project from a project template by providing its unique ID. The newly created project will inherit its attributes from the template. Projects created from a template still require documents to be assigned to them through the endpoint.
Some operations on projects created from templates with translation_memory ,translation_diff or post_editing_machine_translation options enabled will not be performed until explicitly requested through the endpoint.
The expertise or sub-expertise ID. One of the expertise ID returned by the endpoint.
Deprecated: This endpoint is deprecated and will be removed in future version of the API. Use the endpoint instead.
Under the hood, the API will schedule any asynchronous operations configured on the project such as for example, counting the number of words on each document, running the analysis and pre-fill translations.
When combined with the auto_launch option from the endpoint, assuming your account has enough funds, the API will attempt to automatically launch the project as soon as all asynchronous operations have been executed.
Enables the translation_memory , translation_diff and/or post_editing_machine_translation option(s) on given project. This endpoint should be used to request the analysis and/or pre-fill translations operation to be run on the project or .
(required) Project type
(required) Bigram representing a language (ex: en-us). Full list available via API call.
^[a-z]{2}(-[a-z]{2})?$(required for translation projects) Bigram representing a language (ex: en-us). Full list available via API call.
^[a-z]{2}(-[a-z]{2})?$(required) Number of words to quote
URL encoded JSON selector composed of one or several criteria.
Comma separated order list
Search results are limited to 100 items. Specify page number to read more than the first page.