Smartcat API v1 (developer portal)
Base URLs:
https://smartcat.ai/
Fetch the account details
GET /api/integration/v1/account
Responses
Fetch the list of MT services available for the account
GET /api/integration/v1/account/mtengines
Responses
Response Schema
Status Code 200
Get a list of available assignment templates
GET /api/integration/v1/assignment-templates/project/{projectId}
Parameters
Responses
Response Schema
Status Code 200
Apply an assignment template to the project
POST /api/integration/v1/assignment-templates/{assignmentTemplateId}/project/{projectId}
Parameters
Responses
Project tasks are not available for this project
There is an incomplete 'Source layout check' stage for some project documents.| ProblemDetails | |404| Not Found |Returns if:
Project not found
Assignment template not found| ProblemDetails |
Fetch audit logs with given filter parameters
GET /api/integration/v1/audit/logs
Parameters
Responses
Response Schema
Status Code 200
Fetch the notifications settings for the account
GET /api/integration/v1/callback
Responses
Create or update the notifications settings
POST /api/integration/v1/callback
Parameters
Responses
URI is invalid
a header Smartcat.AppIntegrations.Contracts.AdditionalHeaderModel.Name is empty or null, or consists of space characters only
a header Smartcat.AppIntegrations.Contracts.AdditionalHeaderModel.Value is null
a header is formatted incorrectly, that is requires coding or does not conform to special requirements (such as the authorization header)|None|
Delete notifications settings
DELETE /api/integration/v1/callback
Responses
Fetch the latest delivery errors
GET /api/integration/v1/callback/lastErrors
Parameters
Responses
Response Schema
Status Code 200
Create a new client with the specified name and return their ID
Simply return the ID if a client with that name already exists
POST /api/integration/v1/client/create
Parameters
Responses
Apply the specified net rate to the specified client
PUT /api/integration/v1/client/{clientId}/set
Parameters
Responses
Sets contact details for the specified client
PUT /api/integration/v1/client/{clientId}/contact
Parameters
Responses
Update client details
PUT /api/integration/v2/client/{clientId}
Parameters
Responses
contact details are invalid
the provided manager ID is invalid|None| |404| Not Found |The specified client not found|None|
Fetch the client account information
GET /api/integration/v1/client/{clientId}
Parameters
Responses
Fetch a directory entry by ID
GET /api/integration/v1/clientIndustry/{id}
Parameters
Responses
Update the name of an entry by ID
PUT /api/integration/v1/clientIndustry/{id}
Parameters
Responses
Delete a list entry
DELETE /api/integration/v1/clientIndustry/{id}
Parameters
Responses
Fetch all the available directory values
GET /api/integration/v1/clientIndustry
Responses
Response Schema
Status Code 200
Add a directory entry
POST /api/integration/v1/clientIndustry/{name}
Parameters
Responses
Fetch the specified directory
GET /api/integration/v1/directory
Parameters
Responses
Fetch parsing formats supported by the account
GET /api/integration/v1/directory/formats
Responses
Response Schema
Status Code 200
Fetch the document details
GET /api/integration/v1/document
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
Delete one or several documents
DELETE /api/integration/v1/document
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language API call example: ?documentIds=61331\_25&documentIds=61332\_9..
Parameters
Responses
At least one document is not associated with the account
The document is assigned to a vendor who is not allowed to update documents in the assigned projects| ProblemDetails |
Fetch the status of adding document translation
GET /api/integration/v1/document/translate/status
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
Fetch a detailed report on translation import results
GET /api/integration/v1/document/translate/result
Parameters
Responses
Fetch statistics
GET /api/integration/v1/document/statistics
Parameters
Responses
Divide the document into equal blocks by the number of words and assign one block to each specified freelancer
POST /api/integration/v1/document/assignFreelancers
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
The document was not disassembled or was disassembled, but contains 0 words
The provided workflow stage number does not exist in the project
An assignment has been already made to the specified workflow stage
A freelancer ID was not found in CAT| ProblemDetails | |403| Forbidden |The document is not associated with the account| ProblemDetails | |404| Not Found |The provided document ID does not exist| ProblemDetails |
Assign a vendor to a document workflow stage
POST /api/integration/v1/document/assignVendors
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
The document is not associated with the account
The account is a vendor| ProblemDetails | |404| Not Found |Returns if:
The provided document ID does not exist
The provided workflow stage number does not exist in the project
A vendor ID was not found in CAT
The client-to-vendor connection does not exist| ProblemDetails | |409| Conflict |An assignment has been already made to the specified workflow stage| ProblemDetails |
Specify the unit count for a document workflow stage
POST /api/integration/v1/document/setStageUnitCount
Parameters
Responses
The documents are not associated with the project
The stage is internal
The unit count is already set for the stage| ProblemDetails | |403| Forbidden |Returns if:
The project is not associated with the account and the account is not a project vendor
The document is not associated with the account and the vendor is not assigned to the stage| ProblemDetails | |404| Not Found |Returns if:
The provided project ID does not exist
The provided workflow stage number does not exist in the project| ProblemDetails |
Specify the linguist assignment and segment distribution model
POST /api/integration/v1/document/assign
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language AssignmentMode option descriptions: - AssignmentMode.DistributeAmongAll: Distribute segments among all the assigned linguists - AssignmentMode.Rocket: Send invitations and assign all unassigned segments to the first linguist who accepts - AssignmentMode.InviteOnly: Only invite linguists, segments will be assigned later manually Note: If the segment count is not specified, the task will be equally divided among all linguists
Parameters
Responses
The document was not disassembled or was disassembled, but contains 0 words
The provided workflow stage number does not exist in the project
An assignment has been already made to the specified workflow stage
A freelancer ID was not found in CAT
The specified assignment type is unknown
Internal account users (not freelancers) were assigned to AssignmentMode.Rocket or AssignmentMode.InviteOnly
The workflow stage is accomplished outside of Smartcat and its word count/cost are not set (exception: for an in-house freelancer setting word count/cost is not mandatory)| ProblemDetails | |403| Forbidden |Returns if:
The project is not associated with the account
The project is associated with the account, but was assigned to a vendor| ProblemDetails | |404| Not Found |The provided document ID does not exist| ProblemDetails |
Unassign a linguist
POST /api/integration/v1/document/unassign
Parameters
Responses
The provided workflow stage number does not exist in the project
The linguist with the specified ID is not assigned to the document workflow stage| ProblemDetails | |403| Forbidden |Returns if:
The project is not associated with the account
The project is associated with the account, but was assigned to a vendor| ProblemDetails | |404| Not Found |The provided document ID does not exist| ProblemDetails |
Send Rocket invitations to MyTeam linguists:
send invitations, assign the first one to accept the job to every unassigned document segment
POST /api/integration/v1/document/assignFromMyTeam
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
The input model is not provided
No document is specified
The specified documents have different target languages
The specified documents are associated with different projects
The document was not disassembled or was disassembled, but contains 0 words
The provided workflow stage number does not exist in the project
An assignment has been already made to the specified workflow stage
The workflow stage is accomplished outside of Smartcat and its word count/cost are not set (exception: for an in-house freelancer setting word count/cost is not mandatory)|None| |403| Forbidden |Returns if:
The project is not associated with the account
The project is associated with the account, but was assigned to a vendor|None| |404| Not Found |The provided document ID does not exist|None|
Change the document status to Completed
POST /api/integration/v1/document/complete
Parameters
Responses
(This method is obsolete and has been replaced with /api/integration/v2/document/update)
Update the specified document
PUT /api/integration/v1/document/update
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
At least one document is not associated with the account
The document update functionality is not enabled in the account
The document is assigned to a vendor who is not allowed to update documents in the assigned projects|None| |404| Not Found |The provided document ID does not exist|None|
Response Schema
Status Code 200
Update the specified document
PUT /api/integration/v2/document/update
Document ID is represented as int1, where int1 identifies the document
Parameters
Responses
At least one document is not associated with the account
The document update functionality is not enabled in the account
The document is assigned to a vendor who is not allowed to update documents in the assigned projects|None| |404| Not Found |The provided document ID does not exist|None|
Response Schema
Status Code 200
Rename the assigned document
PUT /api/integration/v1/document/rename
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
Update document meta info
PUT /api/integration/v1/document/updateMetaInfo
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
Translate the specified document using the specified translation file
PUT /api/integration/v1/document/translate
Available only for the file formats that support true updates (currently these are resource files with unique resource IDs)
Sets a task to processing. When the API call is completed, the translation might be not finished yet
Document ID is represented as int1\_int2, where int1 identifies the document, and int2 identifies its target language
Parameters
Responses
Import an XLIFF file with document translations
PUT /api/integration/v1/document/translateWithXliff
This method is available only for modified XLIFF files that were exported using the POST /api/integration/v1/document/export method The API call body can include one XLIFF file only
Parameters
Responses
Download the export results
GET /api/integration/v1/document/export/{taskId}
Parameters
Responses
Request the documents export
POST /api/integration/v1/document/export
Parameters
documentIds: Target language IDs (the syntax is documentId\_languageId), where documentId\_languageId is a document ID and languageId is a target language ID
mode: Segment export mode: Current - The current translation, the segment status notwithstanding (what is shown in the editor) Confirmed - Confirmed segments at the specific stage, as defined by the StageNumber parameter. If the stage is not specified, export all segments confirmed at any stage (this behavior is similar to exporting files using the Smartcat interface) Complete - Only completed segments, that is the segments that have passed all the stages and were confirmed at the last one
Responses
the provided array of document IDs is empty
the provided workflow stage number is incorrect
the type of the provided document to be exported to the project is incorrect (for example, Smartcat.AppIntegrations.Contracts.ExportDocumentRequestType.DocumentWithMetadata for a docx-based project)|None| |403| Forbidden |At least one document is not associated with the account|None|
Fetch a disassembly algorithm preset
GET /api/integration/v1/fileDisassemblingAlgorithmPresets/{id}
Parameters
Responses
Update a disassembly algorithm preset
PUT /api/integration/v1/fileDisassemblingAlgorithmPresets/{id}
Parameters
Responses
Delete a preset
DELETE /api/integration/v1/fileDisassemblingAlgorithmPresets/{id}
Parameters
Responses
Fetch all presets for the account
GET /api/integration/v1/fileDisassemblingAlgorithmPresets
Responses
Response Schema
Status Code 200
Create a disassembly algorithm preset
POST /api/integration/v1/fileDisassemblingAlgorithmPresets
Parameters
Responses
Download a file by path
GET /api/integration/v1/file-management/file/{path}
Parameters
Responses
Upload file to a specified path in storage
PUT /api/integration/v1/file-management/file/{path}
Parameters
Responses
Delete a file by path
DELETE /api/integration/v1/file-management/file/{path}
Parameters
Responses
Upload multiple files to a specified path in storage
PUT /api/integration/v1/file-management/files/{path}
Original file names will be used for uploaded files
Parameters
Responses
Response Schema
Status Code 201
Get single file info by path
GET /api/integration/v1/file-management/file-info/{path}
Parameters
Responses
Get list of files whose path starts with given prefix
GET /api/integration/v1/file-management/file-info-list/{prefix}
Parameters
Responses
Fetch glossaries from the current account
GET /api/integration/v1/glossaries
Responses
Response Schema
Status Code 200
Create a task for importing concepts from a glossary file
POST /api/integration/v1/glossary/import
Parameters
Responses
Fetch the status of a concept import task
GET /api/integration/v1/glossary/importTaskState/{taskId}
Parameters
Responses
Create payment to freelancer
POST /api/integration/v1/invoice/job
Parameters
Responses
Create a payment
POST /api/integration/v2/invoice/job
Parameters
Responses
Create an array of freelancer payments
POST /api/integration/v1/invoice/jobs
Parameters
Responses
Response Schema
Status Code 200
Create a payments array
POST /api/integration/v2/invoice/jobs
Parameters
Responses
Response Schema
Status Code 200
Fetch an array of freelancer payments by ID
GET /api/integration/v1/invoice/job/list
Parameters
Responses
Response Schema
Status Code 200
Fetch an array of payments by ID
GET /api/integration/v2/invoice/job/listByExternalId
Parameters
Responses
Response Schema
Status Code 200
Fetch an array of payments by creation date
GET /api/integration/v2/invoice/job/listByCreatedDate
Parameters
Responses
Response Schema
Status Code 200
Fetch a list of invoices created within the specified period
GET /api/integration/v2/invoice/list
Parameters
Responses
Response Schema
Status Code 200
Fetch a list of agent invoices
GET /api/integration/v2/client-agent-invoice/list
Parameters
Responses
Response Schema
Status Code 200
Fetch an array of jobs whose status is VERIFIED
GET /api/integration/v3/job/verifiedForProject
Parameters
Responses
Response Schema
Status Code 200
Fetch an array of jobs
GET /api/integration/v3/job
Parameters
Responses
Response Schema
Status Code 200
Delete an LSP service price
DELETE /api/integration/v1/lsp/prices/{priceId}
Parameters
Responses
Fetch LSP service prices by ID
GET /api/integration/v2/lsp/prices
Parameters
Responses
Response Schema
Status Code 200
Create a new LSP service price
POST /api/integration/v2/lsp/prices
Parameters
Responses
Fetch LSP service prices
GET /api/integration/v2/lsp/prices/batch
Parameters
Responses
Response Schema
Status Code 200
Create new LSP service prices
POST /api/integration/v2/lsp/prices/batch
Parameters
Responses
Response Schema
Status Code 200
Update an existing LSP service price
PUT /api/integration/v2/lsp/prices/{priceId}
Parameters
Responses
Delete an LSP service
DELETE /api/integration/v1/lsp/services/{serviceId}
Parameters
Responses
Fetch LSP services by ID
GET /api/integration/v2/lsp/services
Parameters
Responses
Response Schema
Status Code 200
Create a new LSP service
POST /api/integration/v2/lsp/services
Parameters
Responses
Fetch LSP services
GET /api/integration/v2/lsp/services/batch
Parameters
Responses
Response Schema
Status Code 200
Create new LSP services
POST /api/integration/v2/lsp/services/batch
Parameters
Responses
Response Schema
Status Code 200
Update an existing LSP service
PUT /api/integration/v2/lsp/services/{serviceId}
Parameters
Responses
Fetch a MyTeam member model by ID
GET /api/integration/v1/account/myTeam/{userId}
Parameters
Responses
Delete the user from MyTeam
DELETE /api/integration/v1/account/myTeam/{userId}
Parameters
Responses
Fetch a MyTeam member model by external ID
GET /api/integration/v1/account/myTeam
Parameters
Responses
Add an in-house translator to MyTeam as a linguist
POST /api/integration/v1/account/myTeam
Parameters
Responses
Search for linguists in MyTeam
POST /api/integration/v1/account/searchMyTeam
Parameters
Responses
Maximum required number of results is greater than 500
Specified language is unknown
Specified service type is unknown
Specified subject expertise (specialization) is unknown
Specified currency is unknown
Specified level of subject expertise (specialization) is unknown|None| |404| Not Found |Unable to find an account connected to the integration API|None|
Response Schema
Status Code 200
Replace all services in a MyTeam profile
POST /api/integration/v1/account/myTeam/{userId}/services/replace
Parameters
Responses
Add a MyTeam member's phone number
PUT /api/integration/v1/account/myTeam/{userId}/phone
Parameters
Responses
Add a comment to a MyTeam member profile
PUT /api/integration/v1/account/myTeam/{userId}/comment
Parameters
Responses
Fetch all placeholder formats available in the current account
GET /api/integration/v1/placeholders
Responses
Response Schema
Status Code 200
Save placeholder formats set for the specified account
PUT /api/integration/v1/placeholders
Parameters
Responses
Validate the provided placeholder format
GET /api/integration/v1/placeholders/validate
Parameters
Responses
Receive the project model
GET /api/integration/v1/project/{projectId}
Parameters
Responses
Update a project by ID
PUT /api/integration/v1/project/{projectId}
Parameters
Responses
Delete the project
DELETE /api/integration/v1/project/{projectId}
Parameters
Responses
Fetch the list of account projects
GET /api/integration/v1/project/list
Parameters
Responses
Response Schema
Status Code 200
(This method is obsolete and has been replaced with /api/integration/v2/project/{projectId}/statistics)
Fetch project statistics
GET /api/integration/v1/project/{projectId}/statistics
Parameters
Responses
Response Schema
Status Code 200
Fetch project statistics
GET /api/integration/v2/project/{projectId}/statistics
Parameters
Responses
Enable or disable calculating fuzzy repetitions in the project statistics
PUT /api/integration/v1/project/{projectId}/fuzzyRepetitions
Parameters
Responses
Receive statistics for the completed parts of the project
GET /api/integration/v1/project/{projectId}/completedWorkStatistics
Parameters
Responses
Response Schema
Status Code 200
Receive a list of the TMs plugged into the project
GET /api/integration/v1/project/{projectId}/translationmemories
Parameters
Responses
Response Schema
Status Code 200
Recreate the set of TMs plugged into the project.
The set of TMs is identical for all target languages of the project.
POST /api/integration/v1/project/{projectId}/translationmemories
Parameters
Responses
The provided model with TM IDs to be added to the project is empty
More than one TM has been provided
The match threshold in the TM is smaller than the allowed minimum (50)
A TM appears in the settings multiple times
The Write TM does not include all the project's target languages
The project's source language does not match any source language in the provided TM
None of the project's target languages appears among the target languages in the provided Read TM|None|
Fetch the list of glossaries plugged into the project
GET /api/integration/v1/project/{projectId}/glossaries
Parameters
Responses
Response Schema
Status Code 200
Set a collection of glossaries plugged into the project
PUT /api/integration/v1/project/{projectId}/glossaries
Parameters
Responses
Fetch the project's MT configuration
GET /api/integration/v1/project/{projectId}/mt
Parameters
Responses
Response Schema
Status Code 200
Set an MT configuration in the project
POST /api/integration/v1/project/{projectId}/mt
Parameters
Responses
Fetch all the MT engines and profiles that can be used in the specified project
GET /api/integration/v1/project/{projectId}/mt/available
Parameters
Responses
Response Schema
Status Code 200
Fetch the project pre-processing rules
GET /api/integration/v1/project/{projectId}/pretranslation-rules
Parameters
Responses
Response Schema
Status Code 200
Define project pre-processing rules
PUT /api/integration/v1/project/{projectId}/pretranslation-rules
Parameters
Responses
Fetch the status of removing empty project folders
GET /api/integration/v1/project/{projectId}/empty-folders-removing-status
Parameters
Responses
Fetch the result of import into the Localization Project
GET /api/integration/v1/project/import-result/{importId}
Parameters
Responses
Cancel the project
POST /api/integration/v1/project/cancel
Parameters
Responses
Restore the project
POST /api/integration/v1/project/restore
Parameters
Responses
Complete the workflow for all project documents. As a result, the project status will change to Completed.
POST /api/integration/v1/project/complete
Parameters
Responses
Create the project
POST /api/integration/v1/project/create
Parameters
Responses
The project model is empty
The project description length exceeds the allowed maximum
The user ID was not found in the specified account
The domain ID is incorrect
The client ID is incorrect
The vendor ID is incorrect
The account does not support the test project creation|None| |403| Forbidden |The specified account is personal|None| |404| Not Found |Account not found|None| |409| Conflict |Several documents with identical names are being added to the project|None|
Import keys and values from files into the Software Localization Project
POST /api/integration/v2/project/{projectId}/import
Parameters
target-languages: Comma separated list of target languages (optional, all target languages of the project by default, can only be specified when importing the source).
Empty list of languages produces a 400 bad request error with an appropriate reason text
An incorrect language code produces a 400 bad request error with an appropriate reason text
If any language didn't exist in the project, it will be created (but not added as a target to any existing collections)
If any language didn't exist in the collection (the target collection existed before), it will be added as a target to the collection
format: Specifies the file format used to import the file (optional). Smartcat will try to identify the file format from its extension.
completion-state: Imported translation confirmation mode draft — translation must be imported but not confirmed on any stage (default) intermediate — the translation must be imported and automatically confirmed at the first project stage final — the translation must be imported and confirmed on all project stages
skip-conflicting-values: Specifies how to deal with situations when the same key has a different value in the imported file and in Smartcat - keeps the value in Smartcat by default
Responses
Add a document to the project
POST /api/integration/v1/project/document
Parameters
Responses
Response Schema
Status Code 200
Add a new target language to the project
POST /api/integration/v1/project/language
Parameters
Responses
Remove a target language from the project
DELETE /api/integration/v1/project/language
Parameters
Responses
Recreate the set of TMs plugged into the project.
A separate set of TMs is created for each target language.
POST /api/integration/v1/project/{projectId}/translationmemories/bylanguages
Parameters
Responses
TM settings are not defined
The provided model with TM IDs to be added to the project for one of the languages is empty
More than one TM was provided for one of the languages
The match threshold in the TM is smaller than the allowed minimum (50)
A TM appears in language settings multiple times
The target language associated with the TM does not appear in the Write TM's target languages
The project's source language does not match any source language in the provided TM
The target language associated with the TM does not appear in the Read TM's target languages|None|
Start processing the project statistics
POST /api/integration/v1/project/{projectId}/statistics/build
Parameters
Responses
Add managers to the specified project
POST /api/integration/v1/project/{projectId}/managers
Parameters
Responses
Delete managers from the project
DELETE /api/integration/v1/project/{projectId}/managers
Parameters
Responses
Automatically assign all new documents/segments to current linguists
POST /api/integration/v1/project/{projectId}/assign
Current limitations: 1. Assignments are made to the following stages only: Translation, Editing, Proofreading, Postediting 2. Assignments are made only to documents with an ID
Parameters
Responses
Response Schema
Status Code 200
Add reference files to a project
POST /api/integration/v1/project/{projectId}/ReferenceFiles
Parameters
Responses
Run the empty project folders deletion task
POST /api/integration/v1/project/{projectId}/run-empty-folders-removing
Parameters
Responses
Run export from Software Localization Project
POST /api/integration/v2/project/{projectId}/export
Parameters
path-separator: Path separator string (optional) When exporting "structured-json" and "structured-yaml" file formats, this separator string will be used to split the key into multiple parts and construct the tree structure.
completion-state: Minimal key completion state (optional) Specifies the state in which any key (segment) must be in order to be exported. draft — download any translations, even unconfirmed ones (default) intermediate — download segments at the last confirmed stage final — download segments that passed through all translation stages
output-file-path-template: Output file path template (Optional) Specifies how the output files should be named and located. You can use the {LANGUAGE} and {LABEL:PREFIX} placeholders to customize the output. The {LOCALE:IOS} and {LOCALE:ANDROID} placeholders are also available for platform specific exports. The ability to specify {LABEL:PREFIX} placeholder allows you to export keys that have the PREFIX value of label prefix and use the label suffix to determine the file name. See examples here
Responses
Run copying a project
POST /api/integration/v1/project/{projectId}/copying
Parameters
Responses
Get project copy state
GET /api/integration/v1/project/copying/{taskId}
Parameters
Responses
Get a list of project tasks
GET /api/integration/v1/projectTask/{projectId}/list
Parameters
Responses
Response Schema
Status Code 200
Get information regarding task projectTaskId for project projectId
GET /api/integration/v1/projectTask/{projectId}/{projectTaskId}
Parameters
Responses
Get information about the scope of work, regarding task projectTaskId for project projectId
GET /api/integration/v1/projectTask/{projectId}/{projectTaskId}/scope
Parameters
Responses
Response Schema
Status Code 200
Set the mode of access to perform the work for those who accepted the invitation
PUT /api/integration/v1/projectTask/{projectId}/{projectTaskId}/set-invitation-strategy-type
Parameters
Responses
Assign individual suppliers to perform task projectTaskId
PUT /api/integration/v1/projectTask/{projectId}/{projectTaskId}/individual-assignment
Parameters
Responses
Delete individual assignment
DELETE /api/integration/v1/projectTask/{projectId}/{projectTaskId}/individual-assignment
Parameters
Responses
Assign a supplier to perform task projectTaskId
PUT /api/integration/v1/projectTask/{projectId}/{projectTaskId}/vendor-assignment
Parameters
Responses
Remove supplier assignment
DELETE /api/integration/v1/projectTask/{projectId}/{projectTaskId}/vendor-assignment
Parameters
Responses
Get information about payments to suppliers for the work on task projectTaskId
GET /api/integration/v1/projectTask/{projectId}/{projectTaskId}/payables
Parameters
Responses
Response Schema
Status Code 200
Set a deadline for the task
PUT /api/integration/v1/projectTask/{projectId}/{projectTaskId}/deadline
Parameters
Responses
Move the task volume to another task
POST /api/integration/v1/projectTask/{projectId}/{projectTaskId}/split
Parameters
Responses
Split task into partsCount parts
POST /api/integration/v1/projectTask/{projectId}/{projectTaskId}/splitByParts/{partsCount}
Available for accounts with subscription
Parameters
Responses
Merge task projectTaskId with tasks request
All merged tasks must belong to the same stage Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel.StageId, have the same target language Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel.TargetLanguage and have no agencies/companies assigned to the task During the merge process, existing supplier assignments will be removed. Tasks will be merged and become inaccessible. As a result of the operation, a new task is created, which includes all the scope of work from the merged tasks.
POST /api/integration/v1/projectTask/{projectId}/{projectTaskId}/merge
Parameters
Responses
Fetch information about the project quote
GET /api/integration/v1/Quote/ByVendor/{projectId}
Parameters
Responses
Response Schema
Status Code 200
Fetch a list of quotes by a list of projects
GET /api/integration/v1/Quote/ListByProjectIds
Parameters
Responses
Response Schema
Status Code 200
Fetch the list of quotes for the current account
GET /api/integration/v1/Quote/List
Responses
Response Schema
Status Code 200
Update information on the project quote
PUT /api/integration/v1/Quote/Update
Parameters
Responses
Upload a project quote details file
POST /api/integration/v1/Quote/{id}/Upload
Parameters
Responses
Approve a quote
POST /api/integration/v1/Quote/{id}/Approve
Parameters
Responses
Mark the quote as paid
POST /api/integration/v1/Quote/{id}/MarkAsPaid
Parameters
Responses
Download a cost calculation file
GET /api/integration/v1/Quote/{id}/File
Parameters
Responses
The provided project ID does not exist
Details are missing: file is not attached and generating a new one is not possible|None|
Fetch segment confirmation statistics
GET /api/integration/v2/segment-confirmation-statistics/{projectId}
Parameters
Responses
Response Schema
Status Code 200
Fetch translation
See the AI Translation API guide here
POST /api/integration/v1/smartTranslation/translate
Parameters
Responses
Fetch information about the TM
GET /api/integration/v1/translationmemory/{tmId}
Parameters
Responses
Import TMX files to a TM
POST /api/integration/v1/translationmemory/{tmId}
Parameters
Responses
Delete a TM
DELETE /api/integration/v1/translationmemory/{tmId}
Parameters
Responses
Fetch the available TMs filtered per account
GET /api/integration/v1/translationmemory
Parameters
Responses
Response Schema
Status Code 200
Create an empty TM
POST /api/integration/v1/translationmemory
Parameters
Responses
TM creation model is empty
TM with this name already exists in the account
TM name is not specified
TM source language is defined as a translation target language
An error occurred when creating the TM| ProblemDetails |
Fetch a collection of TMX file import tasks
GET /api/integration/v1/translationmemory/task
Responses
Response Schema
Status Code 200
Export TMX files from the TM database
GET /api/integration/v1/translationmemory/{tmId}/file
Parameters
Responses
Fetch matches from the specified TM
POST /api/integration/v1/translationmemory/matches
Parameters
Responses
Request model is empty
No segment model is specified in the request model
Either source or target is not specified
The tag type is not "Start", "End" or "Placeholder"|None| |403| Forbidden |The account cannot access the TM with the specified ID|None| |404| Not Found |TM with the specified ID was not found|None|
Add an array of target languages to a TM
PUT /api/integration/v1/translationmemory/{tmId}/targets
Parameters
Responses
Target languages are not specified
Target languages contain duplicates
Target languages contain the source language
Target language cannot be deleted
Target languages cannot be updated using the specified parameters| ProblemDetails | |403| Forbidden |The account cannot access the TM with the specified ID| ProblemDetails | |404| Not Found |TM with the specified ID was not found| ProblemDetails |
Removes the specified import task
DELETE /api/integration/v1/translationmemory/task/{taskId}
Parameters
Responses
Fetch the list of vendors
GET /api/integration/v1/vendor/list
Responses
Response Schema
Status Code 200
Fetch a vendor by ID
GET /api/integration/v1/vendor/{vendorAccountId}
Parameters
Responses
AccountModel
Account information for external systems
AddBatchResult
Entity creation result model for batch addition
AdditionalHeaderModel
User header model
AgreementModel
ApprovalStatus
AssignExecutivesRequestModel
Input model of a request for assigning account freelancers or users to a document
AssignExecutivesRequestModel+Executive
Model for the assignment of a freelancer or account user to a document
AssignMyTeamExecutivesRequestModel
Model for assigning documents to MyTeam executors
AssignedExecutiveModel
Model of a linguist assigned to a document workflow stage
AssignmentMode
Linguist assignment mode
AssignmentTemplateApplicationResultModel
Assignment template application result information for external systems
AssignmentTemplateModel
Assignment template information for external systems
AuditLogModel
Audit log model
AutoAssignmentMode
Auto-assignment mode
AutopilotTeamDashboardDto
AutopilotTeamDashboardOrganizationWorkspaceDto
AutopilotTeamDashboardProjectCreatorDto
AutopilotTeamDashboardProjectDto
AutopilotTeamDashboardProjectManagerDto
AutopilotTeamDashboardTasksDto
Balance
BalanceForExport
BankRequisitesModel
BatchResult
"> ">
BilingualFileImportSetingsModel
Bilingual document upload settings model
CallbackErrorModel
Callback error description
CallbackPropertyModel
Notification change model
CancelInvoiceModel
Invoice cancellation model
ClientAgentInvoiceJobModel
ClientAgentInvoiceModel
ClientIndustryModel
Model of an entry in a client's specializations list
ClientModel
Client model
ClientModelV2
Client model
Common.ErrorResponse
ConfirmMode
Mode of segment confirmation at file upload
ContactModel
Contact information model
Contracts.ProjectStatus
Project Status
CostDetailsModel
DTO model of a quoted service price details
CreateClientPayInOrder
Payment request creation model
CreateDocumentPropertyModel
Created document
CreateInvoiceModel
Invoice creation model
CreateProjectModel
Project creation model
CreateProjectNumberModel
Data class for project number creation
CreateTranslationMemoryModel
TM creation model
Currency
CurrencyExchangeRatesTableModel
Currency exchange rate table with the start and end dates
DetalizationRowFileContainerModel
Service details by files
DetalizationRowModel
Service details string model
DirectoryItemModel
Directory entry model
DirectoryModel
Directory model
DirectoryType
Directory type
DocumentDisassemblingStatus
Document disassembly status
DocumentModel
Document model
DocumentStatisticsModel
Document statistics
DocumentStatus
Document status
DocumentWorkflowStageModel
Document workflow stage model
EmptyProjectFoldersRemoveTaskStatus
EndCustomerValue
ErrorResponse
ErrorType
ExecutiveModel
Linguist details
ExecutiveStageProjectCostModel
Supplier task data model
ExecutiveStatisticsModel
Statistics model covering the work accomplished for the project by a specific user, the workflow stage, and the target language
ExportDocumentRequestType
Document download request type
ExportDocumentTaskModel
Export document task model
ExportFromStringsTableModel
Model for export from Software Localization Project
ExportIncompleteTranslationsMode
Export mode for incomplete translations
ExportKeysFromSoftwareLocalizationProjectModel
Model for keys exported from
ExternalFileDetalizationModel
Uploaded file with quote details
ExternalStageStatisticsModel
External stage tasks statistics model
FileDisassemblingAlgorithmPresetCreatedModel
Created preset details
FileDisassemblingAlgorithmPresetEditModel
Preset edit model
FileDisassemblingAlgorithmPresetViewModel
Preset view model
FileFormatModel
Model of file formats supported by the account
FileInfoModel
Information about file uploaded to storage
FreelancerServiceType
Freelancer service type
GlossaryModel
Glossary
HttpStatusCode
ImportJobModel
Basic class of linguist payment models
ImportJobModelV2
Basic class of payment models
ImportToSoftwareLocalizationProjectModelV1
Model for import into the Software Localization Project
IndividualAssignmentModel
Information about the user assigned to the task Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel
IndividualAssignmentRequestModel
Model for inviting individual suppliers to the task
IndividualAssignmentStatus
Status of the invitation to the user to perform the task
InhouseTranslatorCreationModel
In-house translator creation model
IntegrationApiTMTranslationAssuranceLevel
Minimum TM segment quality
InvoiceModel
Invoice model
InvoicePaymentReceiveDestination
InvoiceStatus
Invoice status
JobModel
Linguist payment model
JobModelV2
Payment model
JobModelV2Extended
Payment model
JobStatus
Payment status
LabelModel
Label model
LegalEntityModel
Legal entity details model
LineItemExportData
LockMode
Mode of locking segments at import
LspPriceModelV2
LSP service price model
LspServiceModelV2
LSP service model
LspServiceType
LSP service type
LspUpdatePriceModelV2
LSP service price creation and update model
LspUpdateServiceModelV2
LSP service creation and update model
MTEngineModel
MT (Machine Translation) engine model
MergeProjectTasksResponse
Result of merging tasks
ModelWithFiles
"> ">
ModelWithFiles
"> ">
ModelWithFiles
"> ">
ModelWithFiles
"> ">
MyTeamMemberModel
MyTeam member model
MyTeamSearchRequestModel
MyTeam member search request
NetRateModel
Rate discounts model
NetRateModel+TMRangeRateModel
TM matches rate model
PlaceholderFormatModel
Model for applying a placeholder format to a client
PretranslateRuleModel
Pretranslation rule model
PretranslateRuleType
Pretranslation rule type
ProblemDetails
ProjectAssignmentMode
Indicates the mode in which performers are assigned to the tasks in the project.
ProjectChangesModel
Project changes model
ProjectCopyModel
Model for project copy
ProjectCopyOptions
Data to be copied when copying a project
ProjectCopyStateModel
Project copy state
ProjectCopyStatus
Project copy status
ProjectCostModel
Project cost model
ProjectDetalizationCostModel
Project cost details model
ProjectMTEngineModel
The model represents the addition of an MT engine or profile to the project
ProjectMTEngineSupportedLanguagesModel
The model represents the supported MT engines or profiles
ProjectModel
Project model
ProjectQuoteAccuracyDegree
ProjectStatisticsItemModel
Word count model
ProjectStatisticsObsoleteModel
Project statistics model for a specific target language
ProjectStatus
ProjectTaskIndividualInvitationStrategyType
Mode of access to the work for those who accepted the invitation
ProjectTaskJobModel
Job information for a specific task
ProjectTaskJobStatus
Status of the work performed by the supplier
ProjectTaskMergeRequest
IDs of the tasks to be merged All merged tasks must belong to the same stage Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel.StageId and have the same target language Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel.TargetLanguage
ProjectTaskModel
Project task
ProjectTaskScopeModel
Model containing information about one work item included in the task
ProjectTaskStatus
Task status
ProjectTranslationMemoryModel
Project TM creation model
ProjectType
Project type
ProjectTypeFilter
Project type
ProjectVendorModel
Vendor-to-project connection model
ProjectWorkflowStageModel
Project workflow stage model
QuoteCostDetalizationType
QuoteModel
Project quote model
QuotePaymentStatus
QuoteServiceModel
Quote service model
ReplaceServicesModel
MyTeam member services replacement model
ScopeOfSubstringSearchInProject
Scope of sub-string search
SegmentCompletionState
Segment completion state
SegmentConfirmationStatisticsModel
Item (record) model of segment acknowledgment statistics
SegmentConfirmationStatisticsWordcountsModel
Word count model for segment confirmation statistics
SegmentExportMode
Document export mode
SegmentModel
Segment model
SegmentRevisionBatchModel
Segment revision batch model
SegmentRevisionModel
Segment translation revision model
SegmentSearchRequestModel
Model of request for searching text in project segments
SegmentSearchResultDocumentModel
Segment search result model for results in a specific target language found in a specific document
SegmentSearchResultModel
Project segment search result model
SegmentSearchResultSegmentModel
Segment search result model for one found occurence
SegmentTagModel
Segment tag mandatory information model
SegmentWithMatchesModel
Segment with matches send model
ServiceModel
Service model
ServicesDetalizationModel
Quote details generated by Smartcat
SetStageUnitsCountModel
Document unit count setup model
SmartCatLegalEntityModel
Smartcat legal entity details model
SmartTranslationRequest
Translation request
SmartTranslationResponse
Successful response to a translation request
SmartTranslationResult
SmartTranslationText
Translation text
SoftwareLocalizationDocumentFormat
Software localization document format
Specialization
Text specialization
SpecializationKnowledgeLevel
Level of specialization expertise
SplitProjectTaskByPartsResponse
Result of splitting the task volume
SplitProjectTaskRequest
Data required to split the task volume
SplitProjectTaskResponse
Result of splitting the task volume
StageType
Workflow stage type
StatisticsFieldName
Statistics field names
StatisticsModel
TM matches and repeats model
StatisticsRowModel
Document Statistics Model
StatisticsTMMatchRangeModel
TM matches in a specific translation quality range
StringTableKeyConflictResolution
Key string table key conflict resolution
StringsTableImportResult
StringsTableImportStatus
SupplierType
Supplier type
TMExportMode
TMImportTaskModel
TM import task model
TMMatchesRequest
TM match query model
TMTranslationAssuranceLevel
TagsFromUnit
Unit tags data serialization class
TargetLanguageUsageMode
Target language selection mode for translation
TargetSubstitutionMode
Target substitution mode
TranslationMemoriesForLanguageModel
Project language TMs model
TranslationMemoryForProjectModel
TM for project model
TranslationMemoryModel
TM model
TranslationTaskStatus
Status of a document translation addition task
UpdateClientModel
Client update model
UploadDocumentModel
Document upload model
UploadedFile
UploadedQuoteFileModel
Quote as an attached file
UserSegmentConfirmationStatisticsModel
Item (record) model of segment acknowledgment statistics
VendorAssignmentModel
Information about the agency/company assigned to the task Smartcat.AppIntegrations.Contracts.ProjectTask.ProjectTaskModel
VendorAssignmentRequestModel
Model for inviting a vendor to the task
VendorAssignmentStatus
Vendor assignment status
VendorModel
Vendor model
VendorProjectCostModel
Vendor cost model
VendorServiceModel
Vendor service model
WebApi.WorkUnitType
WorkUnitType
Linguist's work unit
WorkflowStageInDocumentModel
WorkflowStageStatus
Workflow stage status