Getting Started
Changelog
API Guides
API Reference
Smartcat CLI
Software Localization
⎋ Help Center
⎋ smartcat.com
Smartcat API v1
Account
Fetch the account details
Fetch the list of MT services available for the account
AssignmentTemplates
Get a list of available assignment templates
Apply an assignment template to the project
Audit
Fetch audit logs with given filter parameters
Callback
Fetch the notifications settings for the account
Create or update the notifications settings
Delete notifications settings
Fetch the latest delivery errors
Client
Create a new client with the specified name and return their ID
Apply the specified net rate to the specified client
Sets contact details for the specified client
Update client details
Fetch the client account information
ClientIndustry
Fetch a directory entry by ID
Update the name of an entry by ID
Delete a list entry
Fetch all the available directory values
Add a directory entry
Directories
Fetch the specified directory
Fetch parsing formats supported by the account
Document
Fetch the document details
Delete one or several documents
Fetch the status of adding document translation
Fetch a detailed report on translation import results
Fetch statistics
Divide the document into equal blocks by the number of words and assign one block to each specified freelancer
Assign a vendor to a document workflow stage
Specify the unit count for a document workflow stage
Specify the linguist assignment and segment distribution model
Unassign a linguist
Send Rocket invitations to MyTeam linguists:
Change the document status to Completed
(This method is obsolete and has been replaced with /api/integration/v2/document/update)
Update the specified document
Rename the assigned document
Update document meta info
Translate the specified document using the specified translation file
Import an XLIFF file with document translations
DocumentExport
Download the export results
Request the documents export
FileDisassemblingAlgorithmPresets
Fetch a disassembly algorithm preset
Update a disassembly algorithm preset
Delete a preset
Fetch all presets for the account
Create a disassembly algorithm preset
FileManagement
Download a file by path
Upload file to a specified path in storage
Delete a file by path
Upload multiple files to a specified path in storage
Get single file info by path
Get list of files whose path starts with given prefix
Glossary
Fetch glossaries from the current account
Fetch default glossary from the current account
Create a task for importing concepts from a glossary file
Fetch the status of a concept import task
Create a task for export the glossary
Get the list of pending export glossary tasks
Download the glossary export task result
Invoice
Create payment to freelancer
Create a payment
Create an array of freelancer payments
Create a payments array
Fetch an array of freelancer payments by ID
Fetch an array of payments by ID
Fetch an array of payments by creation date
Fetch a list of invoices created within the specified period
Fetch a list of agent invoices
Job
Fetch an array of jobs whose status is VERIFIED
Fetch an array of jobs
LspPrices
Delete an LSP service price
Fetch LSP service prices by ID
Create a new LSP service price
Fetch LSP service prices
Create new LSP service prices
Update an existing LSP service price
LspService
Delete an LSP service
Fetch LSP services by ID
Create a new LSP service
Fetch LSP services
Create new LSP services
Update an existing LSP service
MyTeam
Fetch a MyTeam member model by ID
Delete the user from MyTeam
Fetch a MyTeam member model by external ID
Add an in-house translator to MyTeam as a linguist
Search for linguists in MyTeam
Replace all services in a MyTeam profile
Add a MyTeam member's phone number
Add a comment to a MyTeam member profile
PlaceholderFormatApi
Fetch all placeholder formats available in the current account
Save placeholder formats set for the specified account
Validate the provided placeholder format
Project
Receive the project model
Update a project by ID
Delete the project
Fetch the list of account projects
(This method is obsolete and has been replaced with /api/integration/v2/project/{projectId}/statistics)
Fetch project statistics
Enable or disable calculating fuzzy repetitions in the project statistics
Receive statistics for the completed parts of the project
Receive a list of the TMs plugged into the project
Recreate the set of TMs plugged into the project.
Fetch the list of glossaries plugged into the project
Set a collection of glossaries plugged into the project
Fetch default glossary for the project
Fetch the project's MT configuration
Set an MT configuration in the project
Fetch all the MT engines and profiles that can be used in the specified project
Fetch the project pre-processing rules
Define project pre-processing rules
Fetch the status of removing empty project folders
Fetch the result of import into the Localization Project
Cancel the project
Restore the project
Complete the workflow for all project documents. As a result, the project status will change to Completed.
Create the project
Import keys and values from files into the Software Localization Project
Add a document to the project
Add a new target language to the project
Remove a target language from the project
Recreate the set of TMs plugged into the project.
Start processing the project statistics
Add managers to the specified project
Delete managers from the project
Automatically assign all new documents/segments to current linguists
Add reference files to a project
Run the empty project folders deletion task
Run export from Software Localization Project
Run copying a project
Get project copy state
ProjectTask
Get a list of project tasks
Get information regarding task projectTaskId for project projectId
Get information about the scope of work, regarding task projectTaskId for project projectId
Set the mode of access to perform the work for those who accepted the invitation
Assign individual suppliers to perform task projectTaskId
Delete individual assignment
Assign a supplier to perform task projectTaskId
Remove supplier assignment
Get information about payments to suppliers for the work on task projectTaskId
Set a deadline for the task
Move the task volume to another task
Split task into partsCount parts
Merge task projectTaskId with tasks request
Quote
Fetch information about the project quote
Fetch a list of quotes by a list of projects
Fetch the list of quotes for the current account
Update information on the project quote
Upload a project quote details file
Approve a quote
Mark the quote as paid
Download a cost calculation file
SegmentConfirmationStatistics
Fetch segment confirmation statistics
SmartTranslation
Fetch translation
TranslationMemories
Fetch information about the TM
Import TMX files to a TM
Delete a TM
Fetch the available TMs filtered per account
Create an empty TM
Fetch a collection of TMX file import tasks
Export TMX files from the TM database
Fetch matches from the specified TM
Add an array of target languages to a TM
Removes the specified import task
Vendor
Fetch the list of vendors
Fetch a vendor by ID
Schemas
AccountModel
AddBatchResult
AdditionalHeaderModel
AgreementModel
ApprovalStatus
AssignExecutivesRequestModel
AssignExecutivesRequestModel+Executive
AssignMyTeamExecutivesRequestModel
AssignedExecutiveModel
AssignmentMode
AssignmentTemplateApplicationResultModel
AssignmentTemplateModel
AuditLogModel
AutoAssignmentMode
AutopilotTeamDashboardDto
AutopilotTeamDashboardOrganizationWorkspaceDto
AutopilotTeamDashboardProjectCreatorDto
AutopilotTeamDashboardProjectDto
AutopilotTeamDashboardProjectManagerDto
AutopilotTeamDashboardTasksDto
Balance
BalanceForExport
BankRequisitesModel
BatchResult
BilingualFileImportSetingsModel
CallbackErrorModel
CallbackPropertyModel
CancelInvoiceModel
ClientAgentInvoiceJobModel
ClientAgentInvoiceModel
ClientIndustryModel
ClientModel
ClientModelV2
ConfirmMode
ContactModel
Contracts.ProjectStatus
CostDetailsModel
CreateClientPayInOrder
CreateDocumentPropertyModel
CreateInvoiceModel
CreateProjectModel
CreateProjectNumberModel
CreateTranslationMemoryModel
Currency
CurrencyExchangeRatesTableModel
DetalizationRowFileContainerModel
DetalizationRowModel
DirectoryItemModel
DirectoryModel
DirectoryType
DocumentDisassemblingStatus
DocumentModel
DocumentStatisticsModel
DocumentStatus
DocumentWorkflowStageModel
EmptyProjectFoldersRemoveTaskStatus
EndCustomerValue
ErrorResponse
ErrorType
ExecutiveModel
ExecutiveStageProjectCostModel
ExecutiveStatisticsModel
ExportDocumentRequestType
ExportDocumentTaskModel
ExportFromStringsTableModel
ExportIncompleteTranslationsMode
ExportKeysFromSoftwareLocalizationProjectModel
ExternalFileDetalizationModel
ExternalStageStatisticsModel
FileDisassemblingAlgorithmPresetCreatedModel
FileDisassemblingAlgorithmPresetEditModel
FileDisassemblingAlgorithmPresetViewModel
FileFormatModel
FileInfoModel
FreelancerServiceType
GlossaryExportPendingTaskInfo
GlossaryModel
HttpStatusCode
ImportJobModel
ImportJobModelV2
ImportToSoftwareLocalizationProjectModelV1
IndividualAssignmentModel
IndividualAssignmentRequestModel
IndividualAssignmentStatus
InhouseTranslatorCreationModel
IntegrationApiTMTranslationAssuranceLevel
InvoiceModel
InvoicePaymentReceiveDestination
InvoiceStatus
JobModel
JobModelV2
JobModelV2Extended
JobStatus
LabelModel
LegalEntityModel
LineItemExportData
LockMode
LspPriceModelV2
LspServiceModelV2
LspServiceType
LspUpdatePriceModelV2
LspUpdateServiceModelV2
MTEngineModel
MergeProjectTasksResponse
ModelWithFiles
ModelWithFiles
ModelWithFiles
ModelWithFiles
Models.ErrorResponse
MyTeamMemberModel
MyTeamSearchRequestModel
NetRateModel
NetRateModel+TMRangeRateModel
PlaceholderFormatModel
PretranslateRuleModel
PretranslateRuleType
ProblemDetails
ProjectAssignmentMode
ProjectChangesModel
ProjectCopyModel
ProjectCopyOptions
ProjectCopyStateModel
ProjectCopyStatus
ProjectCostModel
ProjectDetalizationCostModel
ProjectMTEngineModel
ProjectMTEngineSupportedLanguagesModel
ProjectModel
ProjectQuoteAccuracyDegree
ProjectStatisticsItemModel
ProjectStatisticsObsoleteModel
ProjectStatus
ProjectTaskIndividualInvitationStrategyType
ProjectTaskJobModel
ProjectTaskJobStatus
ProjectTaskMergeRequest
ProjectTaskModel
ProjectTaskScopeModel
ProjectTaskStatus
ProjectTranslationMemoryModel
ProjectType
ProjectTypeFilter
ProjectVendorModel
ProjectWorkflowStageModel
QuoteCostDetalizationType
QuoteModel
QuotePaymentStatus
QuoteServiceModel
ReplaceServicesModel
ScopeOfSubstringSearchInProject
SegmentCompletionState
SegmentConfirmationStatisticsModel
SegmentConfirmationStatisticsWordcountsModel
SegmentExportMode
SegmentModel
SegmentRevisionBatchModel
SegmentRevisionModel
SegmentSearchRequestModel
SegmentSearchResultDocumentModel
SegmentSearchResultModel
SegmentSearchResultSegmentModel
SegmentTagModel
SegmentWithMatchesModel
ServiceModel
ServicesDetalizationModel
SetStageUnitsCountModel
SmartCatLegalEntityModel
SmartTranslationRequest
SmartTranslationResponse
SmartTranslationResult
SmartTranslationText
SoftwareLocalizationDocumentFormat
Specialization
SpecializationKnowledgeLevel
SplitProjectTaskByPartsResponse
SplitProjectTaskRequest
SplitProjectTaskResponse
StageType
StatisticsFieldName
StatisticsModel
StatisticsRowModel
StatisticsTMMatchRangeModel
StringTableKeyConflictResolution
StringsTableImportResult
StringsTableImportStatus
SupplierType
TMExportMode
TMImportTaskModel
TMMatchesRequest
TMTranslationAssuranceLevel
TagsFromUnit
TargetLanguageUsageMode
TargetSubstitutionMode
TranslationMemoriesForLanguageModel
TranslationMemoryForProjectModel
TranslationMemoryModel
TranslationTaskStatus
UpdateClientModel
UploadDocumentPropertiesModel
UploadedFile
UploadedQuoteFileModel
UserSegmentConfirmationStatisticsModel
VendorAssignmentModel
VendorAssignmentRequestModel
VendorAssignmentStatus
VendorModel
VendorProjectCostModel
VendorServiceModel
WebApi.WorkUnitType
WorkUnitType
WorkflowStageInDocumentModel
WorkflowStageStatus
HTTP
Shell