API docs by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:Download

collab-project-controller

getProject

path Parameters
projectId
required
integer <int64>

Responses

updateProject

path Parameters
projectId
required
integer <int64>
Request Body schema: application/json
name
required
string [ 0 .. 255 ] characters
description
string [ 0 .. 2000 ] characters
sourceLang
required
string
targetLang
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "sourceLang": "string",
  • "targetLang": "string"
}

deleteProject

path Parameters
projectId
required
integer <int64>

Responses

listProjects

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20

Responses

createProject

Request Body schema: application/json
name
required
string [ 0 .. 255 ] characters
description
string [ 0 .. 2000 ] characters
sourceLang
required
string
targetLang
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "sourceLang": "string",
  • "targetLang": "string"
}

changeProjectStatus

path Parameters
projectId
required
integer <int64>
query Parameters
targetStatus
required
string

Responses

generateInviteCode

path Parameters
projectId
required
integer <int64>

Responses

listChapters

path Parameters
projectId
required
integer <int64>
query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20

Responses

createChapter

path Parameters
projectId
required
integer <int64>
query Parameters
chapterNumber
required
integer <int32>
title
string
sourceText
string

Responses

collabSse

path Parameters
projectId
required
integer <int64>
query Parameters
lastEventId
string

Responses

collab-comment-controller

resolveComment

path Parameters
commentId
required
integer <int64>

Responses

listComments

path Parameters
chapterTaskId
required
integer <int64>
query Parameters
page
integer <int32>
Default: 1
size
integer <int32>
Default: 20

Responses

createComment

path Parameters
chapterTaskId
required
integer <int64>
Request Body schema: application/json
sourceText
string
targetText
string
content
required
string
parentId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "sourceText": "string",
  • "targetText": "string",
  • "content": "string",
  • "parentId": 0
}

deleteComment

path Parameters
commentId
required
integer <int64>

Responses

chapter-task-controller

submitChapter

path Parameters
chapterId
required
integer <int64>
Request Body schema: application/json
translatedText
required
string

Responses

Request samples

Content type
application/json
{
  • "translatedText": "string"
}

reviewChapter

path Parameters
chapterId
required
integer <int64>
Request Body schema: application/json
approved
required
boolean
comment
string [ 0 .. 2000 ] characters

Responses

Request samples

Content type
application/json
{
  • "approved": true,
  • "comment": "string"
}

assignChapter

path Parameters
chapterId
required
integer <int64>
Request Body schema: application/json
assigneeId
required
integer <int64>
reviewerId
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assigneeId": 0,
  • "reviewerId": 0
}

getChapter

path Parameters
chapterId
required
integer <int64>

Responses

listMyChapters

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20

Responses

web-user-controller

getCurrentUserProfile

Responses

updateUserProfile

Request Body schema: application/json
username
string
avatar
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "avatar": "string"
}

getPreferences

Responses

updatePreferences

Request Body schema: application/json
defaultEngine
string
defaultTargetLang
string
enableGlossary
boolean
defaultGlossaryId
integer <int64>
enableCache
boolean
autoTranslateSelection
boolean
fontSize
integer <int32> [ 8 .. 72 ]
themeMode
string

Responses

Request samples

Content type
application/json
{
  • "defaultEngine": "string",
  • "defaultTargetLang": "string",
  • "enableGlossary": true,
  • "defaultGlossaryId": 0,
  • "enableCache": true,
  • "autoTranslateSelection": true,
  • "fontSize": 8,
  • "themeMode": "string"
}

sendResetCode

Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

sendVerificationCode

Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

resetPassword

Request Body schema: application/json
email
required
string
code
required
string
newPassword
required
string [ 6 .. 2147483647 ] characters

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "code": "string",
  • "newPassword": "string"
}

register

Request Body schema: application/json
email
required
string
password
required
string [ 6 .. 2147483647 ] characters
code
required
string
username
string
avatar
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "code": "string",
  • "username": "string",
  • "avatar": "string"
}

refreshToken

Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

logout

header Parameters
Authorization
string

Responses

login

Request Body schema: application/json
email
required
string
password
required
string
from
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "from": "string"
}

changePassword

Request Body schema: application/json
oldPassword
required
string
newPassword
required
string [ 6 .. 2147483647 ] characters

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

getTranslationHistory

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20
status
string

Responses

getStatistics

Responses

getQuota

Responses

web-glossary-controller

getGlossaryDetail

path Parameters
id
required
integer <int64>

Responses

updateGlossaryItem

path Parameters
id
required
integer <int64>
Request Body schema: application/json
sourceWord
required
string [ 0 .. 100 ] characters
targetWord
required
string [ 0 .. 100 ] characters
remark
string [ 0 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "sourceWord": "string",
  • "targetWord": "string",
  • "remark": "string"
}

deleteGlossaryItem

path Parameters
id
required
integer <int64>

Responses

getGlossaryList

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20
search
string

Responses

createGlossaryItem

Request Body schema: application/json
sourceWord
required
string [ 0 .. 100 ] characters
targetWord
required
string [ 0 .. 100 ] characters
remark
string [ 0 .. 500 ] characters

Responses

Request samples

Content type
application/json
{
  • "sourceWord": "string",
  • "targetWord": "string",
  • "remark": "string"
}

importGlossary

Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

getGlossaryTerms

path Parameters
id
required
integer <int64>

Responses

exportGlossary

Responses

stripe-webhook-controller

handleStripeWebhook

Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

plugin-translate-controller

translateWebpage

Request Body schema: application/json
targetLang
required
string
sourceLang
string
engine
string
fastMode
boolean
required
Array of objects (TextItem)

Responses

Request samples

Content type
application/json
{
  • "targetLang": "string",
  • "sourceLang": "string",
  • "engine": "string",
  • "fastMode": true,
  • "textRegistry": [
    ]
}

streamTextTranslate

Request Body schema: application/json
text
required
string
sourceLang
string
targetLang
string
engine
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "sourceLang": "string",
  • "targetLang": "string",
  • "engine": "string",
  • "mode": "string"
}

translateSelection

Request Body schema: application/json
text
required
string
sourceLang
string
targetLang
string
engine
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "sourceLang": "string",
  • "targetLang": "string",
  • "engine": "string",
  • "mode": "string"
}

translateReader

Request Body schema: application/json
content
required
string
targetLang
required
string
sourceLang
string
engine
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "targetLang": "string",
  • "sourceLang": "string",
  • "engine": "string",
  • "mode": "string"
}

premiumTranslateSelection

Request Body schema: application/json
text
required
string
sourceLang
string
targetLang
string
engine
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "sourceLang": "string",
  • "targetLang": "string",
  • "engine": "string",
  • "mode": "string"
}

premiumTranslateReader

Request Body schema: application/json
content
required
string
targetLang
required
string
sourceLang
string
engine
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "targetLang": "string",
  • "sourceLang": "string",
  • "engine": "string",
  • "mode": "string"
}

shared-translate-controller

queryRag

Request Body schema: application/json
text
required
string
targetLang
required
string
sourceLang
string
engine
string

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "targetLang": "string",
  • "sourceLang": "string",
  • "engine": "string"
}

streamDocumentTranslate

query Parameters
sourceLang
string
Default: "auto"
targetLang
string
Default: "zh"
mode
string
Default: "fast"
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

streamDocumentTranslateById

path Parameters
docId
required
integer <int64>
query Parameters
targetLang
string
Default: "zh"
mode
string
Default: "fast"

Responses

getTaskStatus

path Parameters
taskId
required
string

Responses

cancelTask

path Parameters
taskId
required
string

Responses

getTranslationResult

path Parameters
taskId
required
string

Responses

downloadTranslation

path Parameters
taskId
required
string

Responses

deleteHistory

path Parameters
taskId
required
string

Responses

external-translate-controller

translate

Request Body schema: application/json
engine
string
target_lang
required
string
source_lang
string
text
required
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "engine": "string",
  • "target_lang": "string",
  • "source_lang": "string",
  • "text": "string",
  • "mode": "string"
}

batchTranslate

Request Body schema: application/json
engine
string
texts
Array of strings
target_lang
required
string
source_lang
string
mode
string

Responses

Request samples

Content type
application/json
{
  • "engine": "string",
  • "texts": [
    ],
  • "target_lang": "string",
  • "source_lang": "string",
  • "mode": "string"
}

downloadTranslation_1

path Parameters
taskId
required
string

Responses

getModels

Responses

collab-member-controller

inviteMember

path Parameters
projectId
required
integer <int64>
Request Body schema: application/json
email
string
role
required
string
Enum: "OWNER" "REVIEWER" "TRANSLATOR"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "role": "OWNER"
}

joinByCode

query Parameters
inviteCode
required
string

Responses

listMembers

path Parameters
projectId
required
integer <int64>
query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20

Responses

removeMember

path Parameters
projectId
required
integer <int64>
memberId
required
integer <int64>

Responses

plugin-auth-controller

registerDevice

Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

getToken

path Parameters
deviceId
required
string

Responses

web-document-controller

retryDocument

path Parameters
docId
required
integer <int64>

Responses

cancelTranslation

path Parameters
docId
required
integer <int64>

Responses

uploadDocument

query Parameters
sourceLang
string
Default: "auto"
targetLang
required
string
mode
string
Default: "fast"
projectId
integer <int64>
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

getDocuments

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20
status
string
Default: "all"

Responses

getDocument

path Parameters
docId
required
integer <int64>

Responses

deleteDocument

path Parameters
docId
required
integer <int64>

Responses

downloadDocument

path Parameters
docId
required
integer <int64>

Responses

web-api-key-controller

getApiKeys

query Parameters
page
integer <int32>
Default: 1
pageSize
integer <int32>
Default: 20

Responses

createApiKey

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

resetApiKey

path Parameters
id
required
integer <int64>

Responses

revealApiKey

path Parameters
id
required
integer <int64>

Responses

deleteApiKey

path Parameters
id
required
integer <int64>

Responses

subscription-controller

portal

Responses

checkout

Request Body schema: application/json
plan
required
string
billingCycle
required
string

Responses

Request samples

Content type
application/json
{
  • "plan": "string",
  • "billingCycle": "string"
}

cancel

Responses

verify

query Parameters
session_id
required
string

Responses

status

Responses

cache-admin-controller

clearAllCache

Responses

web-platform-controller

getPlatformStats

Responses