Projects

Get a project quote

Get a quote of a project given the provided parameters without actually creating it.

OAuth: This endpoint requires one of the following scopes: project:manage, project:write, project:read or project:quote.

Get a quotation

GEThttps://api.textmaster.com/v1/clients/projects/quotation

Authorization

oauth2

Query parameters

Response

200401403

Gets a quotation

Body

application/json

idstring

namenullable string

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingnullable string

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencenullable string

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

total_costsarray of object

api_template_idnullable string

created_atnullable DateOrNull (object)

updated_atnullable DateOrNull (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templatenullable ObjectOrNull (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/quotation?project%5Blanguage_from%5D=text&project%5Boptions%5D%5Blanguage_level%5D=text&project%5Btotal_word_count%5D=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "total_costs": [
    {
      "currency": "text",
      "amount": 0
    }
  ],
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  }
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects/quotation" \
  --date-urlencode "project[activity_name]=translation" \
  --date-urlencode "project[options][language_level]=enterprise" \
  --date-urlencode "project[options][quality]=yes" \
  --date-urlencode "project[language_from]=fr" \
  --date-urlencode "project[language_to]=en" \
  --data-urlencode "project[total_word_count]=100" \
  -H "Authorization: Bearer 59e939b01b92c929166f18b9888990f0e4ef5b691ddbbabed2d75aa21317d452"

List projects

OAuth: This endpoint requires one of the following scopes: project:manage, project:write or project:read.

List Projects

GEThttps://api.textmaster.com/v1/clients/projects

Authorization

oauth2

Query parameters

Response

200401403

Lists Projects

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

projectsarray of Project (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "total_pages": 0,
  "count": 0,
  "page": 0,
  "per_page": 0,
  "previous_page": 0,
  "next_page": 0,
  "projects": [
    {
      "id": "text",
      "name": "text",
      "language_from": "text",
      "language_to": "text",
      "language_from_code": "text",
      "language_to_code": "text",
      "category": "C001",
      "vocabulary_type": "not_specified",
      "target_reader_groups": "not_specified",
      "grammatical_person": "not_specified",
      "project_briefing": "text",
      "project_briefing_is_rich": false,
      "priority": 0,
      "status": "in_creation",
      "total_word_count": 0,
      "documents_statuses": {
        "in_creation": 0,
        "waiting_assignment": 0,
        "in_progress": 0,
        "in_review": 0,
        "incomplete": 0,
        "completed": 0,
        "paused": 0,
        "canceled": 0,
        "quality_control": 0,
        "copyscape": 0,
        "counting_words": 0,
        "in_extra_review": 0
      },
      "progress": 0,
      "same_author_must_do_entire_project": false,
      "callback": {
        "url": "text",
        "format": "text"
      },
      "external_id": "text",
      "multi_project_id": "text",
      "auto_launch": false,
      "project_template_id": "text",
      "finalized": false,
      "word_count_error": "text",
      "cost_in_credits": 0,
      "ctype": "translation",
      "creation_channel": "text",
      "reference": "text",
      "cost_per_word": {
        "currency": "text",
        "amount": 0
      },
      "options": {
        "language_level": "enterprise"
      },
      "option_values": {
        "language_level": "enterprise"
      },
      "textmasters": [
        "text"
      ],
      "glossaries": [
        "text"
      ],
      "cost_in_currency": {
        "currency": "text",
        "amount": 0
      },
      "api_template_id": "text",
      "created_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "updated_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "launched_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "completed_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "work_template": {
        "name": "text",
        "description": "text",
        "image_preview_path": "text",
        "ctype": "public"
      }
    }
  ]
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects" \
  -H "Authorization: Bearer 54561947218dc1abd692a19cb02c7256cac140dc33e10406d3e093b2accd68f1"

Filter projects

OAuth: This endpoint requires one of the following scopes: project:manage, project:write or project:read.

Filter Projects

GEThttps://api.textmaster.com/v1/clients/projects/filter

Authorization

oauth2

Query parameters

Response

200401403

Lists Projects

Body

application/json

total_pagesinteger

countinteger

pageinteger

per_pageinteger

previous_pagenullable integer

next_pagenullable integer

projectsarray of Project (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/filter', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "total_pages": 0,
  "count": 0,
  "page": 0,
  "per_page": 0,
  "previous_page": 0,
  "next_page": 0,
  "projects": [
    {
      "id": "text",
      "name": "text",
      "language_from": "text",
      "language_to": "text",
      "language_from_code": "text",
      "language_to_code": "text",
      "category": "C001",
      "vocabulary_type": "not_specified",
      "target_reader_groups": "not_specified",
      "grammatical_person": "not_specified",
      "project_briefing": "text",
      "project_briefing_is_rich": false,
      "priority": 0,
      "status": "in_creation",
      "total_word_count": 0,
      "documents_statuses": {
        "in_creation": 0,
        "waiting_assignment": 0,
        "in_progress": 0,
        "in_review": 0,
        "incomplete": 0,
        "completed": 0,
        "paused": 0,
        "canceled": 0,
        "quality_control": 0,
        "copyscape": 0,
        "counting_words": 0,
        "in_extra_review": 0
      },
      "progress": 0,
      "same_author_must_do_entire_project": false,
      "callback": {
        "url": "text",
        "format": "text"
      },
      "external_id": "text",
      "multi_project_id": "text",
      "auto_launch": false,
      "project_template_id": "text",
      "finalized": false,
      "word_count_error": "text",
      "cost_in_credits": 0,
      "ctype": "translation",
      "creation_channel": "text",
      "reference": "text",
      "cost_per_word": {
        "currency": "text",
        "amount": 0
      },
      "options": {
        "language_level": "enterprise"
      },
      "option_values": {
        "language_level": "enterprise"
      },
      "textmasters": [
        "text"
      ],
      "glossaries": [
        "text"
      ],
      "cost_in_currency": {
        "currency": "text",
        "amount": 0
      },
      "api_template_id": "text",
      "created_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "updated_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "launched_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "completed_at": {
        "day": 0,
        "month": 0,
        "year": 0,
        "full": "text"
      },
      "work_template": {
        "name": "text",
        "description": "text",
        "image_preview_path": "text",
        "ctype": "public"
      }
    }
  ]
}

Parameters

You can use the Filter API to filter documents on a collection of criteria.

Name	Type	Description
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	The status of the project. See the Workflow section.
created_at	string	Describes the time the project was created. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
updated_at	string	Describes the time the project was last updated. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
launched_at	string	Describes the time the project was launched. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
completed_at	string	Describes the time the project was completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
cached_documents_count	integer	The number of documents in a project.
language_from_code	string	The source language code of the project. One of the language code returned by the Language endpoint.
language_to_code	string	The target language code of the project. One of the language code returned by the Language endpoint.
level_name	string	The level of the project. One of the level names returned by the Level endpoint.
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	The category identifier for the project. One of the category returned by the Category endpoint.
platform_id	string	The unique UUID of the integration platform. Used to tell apart projects created via different integrations (Salesforce, Wordpress, etc.).

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects/filter" \
  --data-urlencode 'where={"total_word_count":{"$gt":100},"language_from_code":"fr","language_to_code":"en"}' \
  --data-urlencode 'order=level_name' \
  -H "Authorization: Bearer 423773845b670244f0d3025c0be48de100f29482665e98c89e8dd31051938f12"

Get a project

OAuth: This endpoint requires one of the following scopes: project:manage, project:write or project:read.

Get a Project

GEThttps://api.textmaster.com/v1/clients/projects/{project_id}

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Gets the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl -G "https://api.textmaster.com/v1/clients/projects/61698af48b81926d91c0f3d1" \
  -H "Authorization: Bearer f93607587ed3813d5339f77aa69fe0aa217366030149b9d60e50f21ed2182313"

Create a project

Creates a project and assign its document later or create a project with documents embedded along with the project's attributes.

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 Translation Memory 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 Launch a project endpoint.

Using a project template

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 Create document 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 Finalize project endpoint.

Available options

A project can be created with the following options:

Name	Type	Description
language_level	string	Required. premium or enterprise.
quality	boolean	Whether the project should be sent to quality control or not.
expertise	string	The expertise or sub-expertise ID. One of the expertise ID returned by the Expertise endpoint.
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.

OAuth: This endpoint requires one of the following scopes: project:manage, project:read or project:write.

Create a Project

POSThttps://api.textmaster.com/v1/clients/projects

Authorization

oauth2

Body

application/json

project*object

Response

200401403

Project Created

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": {
        "activity_name": "text",
        "category": "text",
        "language_from": "text",
        "name": "text",
        "options": {
          "language_level": "text"
        },
        "project_briefing": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects" \
  -X POST \
  -d '{
    "project": {
      "name": "My project",
      "activity_name": "translation",
      "language_from": "fr-fr",
      "language_to": "en-us",
      "category": "C014",
      "vocabulary_type": "not_specified",
      "target_reader_groups": "not_specified",
      "grammatical_person": "not_specified",
      "project_briefing": "Some instructions.",
      "glossaries": [
        "e9a081d1-c920-4bb4-b63e-6faea5ae9a8d"
      ],
      "textmasters": [
        "641c18428b81928a34b96070"
      ],
      "options": {
        "translation_memory": true,
        "post_editing_machine_translation": true,
        "language_level": "enterprise",
        "expertise": "61698af08b81926d91c0f320"
      },
      "custom_data": {
        "tags":["red", "soft"],
        "external_client_id": 1234
      },
      "deadline": "2020-12-30 12:34:56 UTC"
    }
  }' \
  -H "Authorization: Bearer f8f704163650f148b6a4b4e7eb8826d4e6c8cdb2bd16dfa84704ca651b251d34" \
  -H "Content-Type: application/json"

Duplicate a project

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

OAuth: This endpoint requires one of the following scopes: project:manage, project:read or project:write.

Duplicate a Project

POSThttps://api.textmaster.com/v1/clients/projects/{project_id}/duplicate

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Project Duplicated

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/duplicate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698aca8b81926d91c0ed01/duplicate" \
  -X POST \
  -H "Authorization: Bearer cd11cd0b8ba828e611ebdcf57a173f5eb8e9b5776711d3c4d694f93c51ad3368" \
  -H "Content-Type: application/json"

Launch a project

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.

OAuth: This endpoint requires one of the following scopes: project:manage or project:launch.

Launch a Project asynchronously

POSThttps://api.textmaster.com/v1/clients/projects/{project_id}/async_launch

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403422

Launches the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/async_launch', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698ad18b81926d91c0ee39/async_launch" \
  -X POST \
  -H "Authorization: Bearer e5bb8d4315309202ea38b43cab7d09a95797aa2bc12d29e9c48a7347cd256094" \
  -H "Content-Type: application/json"

Launch a project synchronously

Deprecated: This endpoint is deprecated and will be removed in future version of the API. Use the Launch a project endpoint instead.

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.

OAuth: This endpoint requires one of the following scopes: project:manage or project:launch.

Launch a Project synchronously

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/launch

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403422

Launches the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/launch', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698acd8b81926d91c0eda9/launch" \
  -X PUT \
  -H "Authorization: Bearer 3d4f8762bd41328ded69d9eeddbf9fa21ffca3ee6bf207fbcece15746a504a12"

Finalize a project

Instruct the API that all documents have been created for this project and asynchronous operations should be started as soon as possible.

Tips: The finalize endpoint only applies to projects created from a project template.

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.

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 Translation Memory analysis and pre-fill translations.

When combined with the auto_launch option from the create project 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.

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.

OAuth: This endpoint requires one of the following scopes: project:manage or project:launch.

Finalize a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/finalize

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Finalizes the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/finalize', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698aea8b81926d91c0f20a/finalize" \
  -X PUT \
  -H "Authorization: Bearer 12e8b324b29b41a23362ab5a44349e712d1f1beb80dec043b6168f6706ae4e64"

Update a project

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Update a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Body

application/json

project*object

Response

200401403422

Project Updated

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": {}
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698af88b81926d91c0f4bf" \
  -X PUT \
  -d '{ "project": { "name": "Some new name" } }' \
  -H "Authorization: Bearer bc02a6185a7c47bc20fff504b31a0c5b502b7ea3ab4f7cf6b85a8ac4c261cfc3" \
  -H "Content-Type: application/json"

Pause a project

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Pause a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/pause

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Pauses the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/pause', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698ad88b81926d91c0ef5b/pause" \
  -X PUT \
  -H "Authorization: Bearer 4c66e6c844e7dacf5916e701030eeb06c6fd572c228b04a3572c763197e84b83"

Resume a paused project

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Resume a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/resume

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Resumes the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/resume', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698adc8b81926d91c0efe2/resume" \
  -X PUT \
  -H "Authorization: Bearer c778bb88983e52afc9cf90f78efeee5fdcc49f96bda75ce6a785274fb7fc552f"

Cancel a project

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Cancels a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/cancel

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Cancels the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/cancel', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698ad58b81926d91c0eece/cancel" \
  -X PUT \
  -H "Authorization: Bearer 3da5d6892b3c8f70c3f6db295451474c6c50cd3cf433600719994e2263aa2d1c"

Archive a project

Only completed or cancelled projects can be archived.

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Archive a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/archive

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Archives the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/archive', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698ae08b81926d91c0f06b/archive" \
  -X PUT \
  -H "Authorization: Bearer 125a475543052ee628fd9f0841f07953d4ae23575762e0ce7e21dfd543c66666"

Unarchive a project

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Unarchive a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/unarchive

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Response

200401403

Unarchives the Project

Body

application/json

idstring

namestring

language_fromstring

language_tostring

language_from_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

language_to_codestring

Pattern: ^[a-z]{2}(-[a-z]{2})?$

categoryenum

C001C002C003C004C005C006C007C008C009C010C011C012C013C014C015C016C017C018C019C020C021C022C023C024C025C026C027C028C029C030C031C032C033C034

vocabulary_typeenum

not_specifiedpopulartechnicalfictional

target_reader_groupsenum

not_specifiedchildrenteenageryoung_adultsadultsold_adults

grammatical_personenum

not_specifiedfirst_person_singularsecond_person_singularthird_person_singular_masculinethird_person_singular_femininethird_person_singular_neuterfirst_person_pluralsecond_person_pluralthird_person_plural

custom_dataobject

project_briefingstring

project_briefing_is_richboolean

prioritynumber

statusenum

in_creationin_progressin_reviewpausedcompletedcanceled

total_word_countinteger

documents_statusesobject

progressnumber

same_author_must_do_entire_projectboolean

callbackCallbackUrl (object)

external_idnullable string

multi_project_idnullable string

auto_launchboolean

project_template_idnullable string

finalizedboolean

word_count_errornullable string

cost_in_creditsnumber

ctypeenum

translationcopywritingproofreading

creation_channelstring

referencestring

cost_per_wordobject

optionsobject

option_valuesobject

textmastersarray of string

glossariesarray of string

cost_in_currencyobject

api_template_idnullable string

created_atDate (object)

updated_atDate (object)

launched_atnullable DateOrNull (object)

completed_atnullable DateOrNull (object)

work_templateWorkTemplate (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/unarchive', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "language_from": "text",
  "language_to": "text",
  "language_from_code": "text",
  "language_to_code": "text",
  "category": "C001",
  "vocabulary_type": "not_specified",
  "target_reader_groups": "not_specified",
  "grammatical_person": "not_specified",
  "project_briefing": "text",
  "project_briefing_is_rich": false,
  "priority": 0,
  "status": "in_creation",
  "total_word_count": 0,
  "documents_statuses": {
    "in_creation": 0,
    "waiting_assignment": 0,
    "in_progress": 0,
    "in_review": 0,
    "incomplete": 0,
    "completed": 0,
    "paused": 0,
    "canceled": 0,
    "quality_control": 0,
    "copyscape": 0,
    "counting_words": 0,
    "in_extra_review": 0
  },
  "progress": 0,
  "same_author_must_do_entire_project": false,
  "callback": {
    "url": "text",
    "format": "text"
  },
  "external_id": "text",
  "multi_project_id": "text",
  "auto_launch": false,
  "project_template_id": "text",
  "finalized": false,
  "word_count_error": "text",
  "cost_in_credits": 0,
  "ctype": "translation",
  "creation_channel": "text",
  "reference": "text",
  "cost_per_word": {
    "currency": "text",
    "amount": 0
  },
  "options": {
    "language_level": "enterprise"
  },
  "option_values": {
    "language_level": "enterprise"
  },
  "textmasters": [
    "text"
  ],
  "glossaries": [
    "text"
  ],
  "cost_in_currency": {
    "currency": "text",
    "amount": 0
  },
  "api_template_id": "text",
  "created_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "updated_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "launched_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "completed_at": {
    "day": 0,
    "month": 0,
    "year": 0,
    "full": "text"
  },
  "work_template": {
    "name": "text",
    "description": "text",
    "image_preview_path": "text",
    "ctype": "public"
  }
}

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698ae68b81926d91c0f17d/unarchive" \
  -X PUT \
  -H "Authorization: Bearer 88d733ecc072991e0a9e9a761e8dfc77abbedef0aa7e38705be4ba1bd9fe8ac1"

Enable translation memory options on project

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 Translation Memory analysis and/or pre-fill translations operation to be run on the project or Machine Translation.

OAuth: This endpoint requires one of the following scopes: project:manage or project:write.

Activate Translation Memory options on a Project

PUThttps://api.textmaster.com/v1/clients/projects/{project_id}/activate_tm_options

Authorization

oauth2

Path parameters

project_id*string

The Project ID.

Body

application/json

project*object

Response

401403

Unauthorized

Body

application/json

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.textmaster.com/v1/clients/projects/{project_id}/activate_tm_options', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": {
        "options": {}
      }
    }),
});
const data = await response.json();

Code samples

curl "https://api.textmaster.com/v1/clients/projects/61698aec8b81926d91c0f287/activate_tm_options" \
  -X PUT \
  -d '{
    "project": {
      "options": {
        "translation_memory": true,
        "translation_diff": true,
        "post_editing_machine_translation": true
      }
    }
  }' \
  -H "Authorization: Bearer ebdeb743536b7300db174320b7b4924e388bb7a5bd252faa888016ca68d2366d" \
  -H "Content-Type: application/json"