How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Smartcat Document API

The Document API from Smartcat — 16 operation(s) for document.

Smartcat Document API is one of 29 APIs that Smartcat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 17 operations across 16 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

17 operations 16 paths 27 schemas 1 DELETE4 GET7 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://smartcat.com/api/integration/v1
Resource Areas
1

Paths & Operations 17

Across 16 paths, the API surfaces 17 operations — 1 DELETE, 4 GET, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 17
GET
/api/integration/v1/document
Fetch the document details
1 param → 200404403
DELETE
/api/integration/v1/document
Delete one or several documents
1 param → 204400403
GET
/api/integration/v1/document/translate/status
Fetch the status of adding document translation
1 param → 200403404
GET
/api/integration/v1/document/translate/result
Fetch a detailed report on translation import results
1 param → 200404
GET
/api/integration/v1/document/statistics
Fetch statistics
2 params → 200202403422
POST
/api/integration/v1/document/assignFreelancers
Divide the document into equal blocks by the number of words and assign one block to each specified freelancer
2 params body → 204400403404
POST
/api/integration/v1/document/assignVendors
Assign a vendor to a document workflow stage
3 params → 204400403404409
POST
/api/integration/v1/document/setStageUnitCount
Specify the unit count for a document workflow stage
3 params body → 204400403404
POST
/api/integration/v1/document/assign
Specify the linguist assignment and segment distribution model
2 params body → 204400403404
POST
/api/integration/v1/document/unassign
Unassign a linguist
2 params body → 204400403404
POST
/api/integration/v1/document/assignFromMyTeam
Send Rocket invitations to MyTeam linguists: send invitations, assign the first one to accept the job to every unassigned document segment
body → 200403400404
POST
/api/integration/v1/document/complete
Change the document status to Completed
1 param → 200204400404
PUT
/api/integration/v2/document/update
Update the specified document
3 params body → 200400403404
PUT
/api/integration/v1/document/rename
Rename the assigned document
2 params → 204403404409
PUT
/api/integration/v1/document/updateMetaInfo
Update document meta info
1 param body → 202403404204
PUT
/api/integration/v1/document/translate
Translate the specified document using the specified translation file
3 params body → 202403404
PUT
/api/integration/v1/document/translateWithXliff
Import an XLIFF file with document translations
3 params body → 202403404

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are DocumentModel (22 properties), DocumentWorkflowStageModel (8 properties), StatisticsRowModel (8 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

AssignedExecutiveModel
object
Model of a linguist assigned to a document workflow stage
4 properties
SaveType
string
Revision type
VendorModel
object
Vendor model
3 properties
Specialization
string
Text specialization
BilingualFileImportSetingsModel
object
Bilingual document upload settings model
5 properties
AssignExecutivesRequestModel_Executive
object
Model for the assignment of a freelancer or account user to a document
2 properties
ConfirmMode
string
Mode of segment confirmation at file upload
AssignMyTeamExecutivesRequestModel
object
Model for assigning documents to MyTeam executors
4 properties
DocumentDisassemblingStatus
string
Document disassembly status
AssignExecutivesRequestModel
object
Input model of a request for assigning account freelancers or users to a document
3 properties
DocumentStatisticsModel
object
Document statistics
2 properties
StatisticsFieldName
string
Statistics field names
DocumentWorkflowStageModel
object
Document workflow stage model
8 properties
TranslationTaskStatus
string
Status of a document translation addition task
WorkflowStageStatus
string
Workflow stage status
LockMode
string
Mode of locking segments at import
TargetLanguageUsageMode
string
Target language selection mode for translation
SetStageUnitsCountModel
object
Document unit count setup model
2 properties
UploadDocumentPropertiesModel
object
Document upload properties model
2 properties
DocumentPackageModel
object
Package information for a document that belongs to a file package
3 properties
AssignmentMode
string
Linguist assignment mode
StatisticsRowModel
object
Document Statistics Model
8 properties
DocumentModel
object
Document model
22 properties
SupplierType
string
Supplier type
TargetSubstitutionMode
string
Target substitution mode
ProblemDetails
object
5 properties
DocumentStatus
string
Document status

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smartcat-document-api-openapi.yml Raw ↑

Other APIs Smartcat publishes across the network.

Smartcat Account API
Smartcat AssignmentTemplates API
Smartcat Audit API
Smartcat Callback API
Smartcat Client API
Smartcat ClientIndustry API
Smartcat CustomFields API
Smartcat Directories API
Smartcat DocumentExport API
Smartcat FileDisassemblingAlgorithmPresets API
Smartcat FileManagement API
Smartcat Glossary API
Where this information came from

This is an independent, third-party profile of Smartcat Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.