ParaTranz OpenAPI

https://paratranz.cn/api-docs
Admin
ParaTranz OpenAPI provides a comprehensive REST API for managing translation projects, including...
Tokens:22,061
Snippets:96
Trust Score:7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Project List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of projects with pagination support.

```APIDOC
## GET /websites/projects

### Description
This endpoint retrieves a paginated list of projects. You can filter projects by user ID and specify pagination parameters.

### Method
GET

### Endpoint
`/websites/projects`

### Parameters
#### Query Parameters
- **userId** (integer) - Optional - Filter projects by a specific user ID.
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects?userId=456&page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of project objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 100,
    "pageCount": 2,
    "results": [
      {
        "projectId": 123,
        "name": "My Awesome Project",
        "description": "A project for translating awesome content.",
        "language": "en-US",
        "userId": 456
      }
    ]
  }
}
```
```

--------------------------------

### Get Project Details

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves detailed information about a specific project.

```APIDOC
## GET /websites/projects/{projectId}

### Description
This endpoint retrieves detailed information about a specific project using its ID.

### Method
GET

### Endpoint
`/websites/projects/{projectId}`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

### Request Example
```json
{
  "example": "GET /websites/projects/123"
}
```

### Response
#### Success Response (200)
- **projectId** (integer) - The unique identifier for the project.
- **name** (string) - The name of the project.
- **description** (string) - A description of the project.
- **language** (string) - The primary language of the project.
- **userId** (integer) - The ID of the user who owns the project.

#### Response Example
```json
{
  "example": {
    "projectId": 123,
    "name": "My Awesome Project",
    "description": "A project for translating awesome content.",
    "language": "en-US",
    "userId": 456
  }
}
```
```

--------------------------------

### GET /projects

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of projects accessible to the authenticated user. Supports pagination.

```APIDOC
## GET /projects

### Description
Get a list of projects.

### Method
GET

### Endpoint
`/projects`

### Query Parameters
*   **page** (integer) - Optional - The page number for pagination.
*   **pageSize** (integer) - Optional - The number of items per page.

### Responses
#### Success Response (200)
*   **projects** (array) - A list of project objects.
    *   **id** (integer) - Project ID.
    *   **name** (string) - Project name.
    *   **description** (string) - Project description.
    *   **created_at** (string) - Timestamp of creation.
    *   **updated_at** (string) - Timestamp of last update.

#### Response Example (200)
```json
{
  "projects": [
    {
      "id": 1,
      "name": "My Project",
      "description": "This is my first project.",
      "created_at": "2023-01-01T10:00:00Z",
      "updated_at": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get API Token and Authorize Requests

Source: https://paratranz.cn/api-docs/index_format=json

To interact with the ParaTranz API, you first need to obtain an API Token from your profile settings. This token should be included in the 'Authorization' header of your requests as a Bearer token. The example below shows how to make a GET request to the projects endpoint using cURL.

```bash
$ curl --header "Authorization: Bearer {TOKEN}" https://paratranz.cn/api/projects
```

--------------------------------

### Get File List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of files within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/files

### Description
This endpoint retrieves a paginated list of files associated with a specific project. You can specify the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/files`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/files?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of file objects.

#### Response Example
```json
{
  "example": [
    {
      "fileId": 789,
      "fileName": "strings.json",
      "language": "en-US",
      "size": 1024
    }
  ]
}
```
```

--------------------------------

### Get Member List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of members for a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/members

### Description
This endpoint retrieves a list of members associated with a specific project. It supports specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/members`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/members?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of member objects.

#### Response Example
```json
{
  "example": [
    {
      "userId": 456,
      "username": "johndoe",
      "role": "admin"
    }
  ]
}
```
```

--------------------------------

### Get Term List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of terms within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/terms

### Description
This endpoint retrieves a paginated list of terms associated with a specific project. It allows for specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/terms`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/terms?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of term objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 150,
    "pageCount": 3,
    "results": [
      {
        "termId": 201,
        "term": "translation",
        "definition": "The process of converting text from one language to another."
      }
    ]
  }
}
```
```

--------------------------------

### GET /projects/{projectId}

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves detailed information about a specific project using its ID.

```APIDOC
## GET /projects/{projectId}

### Description
Get project details by ID.

### Method
GET

### Endpoint
`/projects/{projectId}`

### Path Parameters
*   **projectId** (integer) - Required - The ID of the project to retrieve.

### Responses
#### Success Response (200)
*   **id** (integer) - Project ID.
*   **name** (string) - Project name.
*   **description** (string) - Project description.
*   **created_at** (string) - Timestamp of creation.
*   **updated_at** (string) - Timestamp of last update.

#### Response Example (200)
```json
{
  "id": 1,
  "name": "My Project",
  "description": "This is my first project.",
  "created_at": "2023-01-01T10:00:00Z",
  "updated_at": "2023-01-01T10:00:00Z"
}
```
```

--------------------------------

### Get String List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of strings (terms) within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/strings

### Description
This endpoint retrieves a paginated list of strings (terms) within a specific project. It supports specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/strings`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/strings?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of string item objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 200,
    "pageCount": 4,
    "results": [
      {
        "stringId": 101,
        "key": "greeting",
        "value": "Hello",
        "language": "en-US",
        "comment": "A friendly greeting."
      }
    ]
  }
}
```
```

--------------------------------

### GET /projects/{projectId}/files

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of files within a specified project.

```APIDOC
## GET /projects/{projectId}/files

### Description
Get a list of files within a project.

### Method
GET

### Endpoint
`/projects/{projectId}/files`

### Path Parameters
*   **projectId** (integer) - Required - The ID of the project.

### Responses
#### Success Response (200)
*   **files** (array) - A list of file objects.
    *   **id** (integer) - File ID.
    *   **name** (string) - File name.
    *   **path** (string) - File path within the project.
    *   **created_at** (string) - Timestamp of creation.

#### Response Example (200)
```json
{
  "files": [
    {
      "id": 101,
      "name": "example.txt",
      "path": "/docs/example.txt",
      "created_at": "2023-01-03T09:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Issue List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of issues (discussions) within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/issues

### Description
This endpoint retrieves a paginated list of issues (discussions) within a specific project. It provides counts for open and closed issues and supports pagination.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/issues`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/issues?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **closedCount** (integer) - The number of closed issues.
- **openCount** (integer) - The number of open issues.
- **results** (array) - An array of issue objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 75,
    "pageCount": 2,
    "closedCount": 30,
    "openCount": 45,
    "results": [
      {
        "issueId": 401,
        "title": "Typo in welcome message",
        "createdAt": "2023-10-26T08:00:00Z",
        "status": "open",
        "user": {
          "userId": 456,
          "username": "johndoe"
        },
        "subscribers": [456, 789],
        "childrenCount": 3,
        "repliedAt": "2023-10-27T09:30:00Z"
      }
    ]
  }
}
```
```

--------------------------------

### GET /mails

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of private messages.

```APIDOC
## GET /mails

### Description
Retrieves a list of private messages.

### Method
GET

### Endpoint
/mails

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **MailList** (object) - A list of private messages.

#### Response Example
```json
{
  "total": 5,
  "mails": [
    {
      "id": 1,
      "fromUserId": 1,
      "toUserId": 2,
      "subject": "Hello",
      "content": "Hi there!",
      "createdAt": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### GET /users/{userId}

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves information about a specific user.

```APIDOC
## GET /users/{userId}

### Description
Retrieves information about a specific user.

### Method
GET

### Endpoint
/users/{userId}

### Parameters
#### Path Parameters
- **userId** (integer) - Required - The ID of the user.

### Response
#### Success Response (200)
- **User** (object) - The user's information.

#### Response Example
```json
{
  "id": 1,
  "username": "ExampleUser",
  "nickname": "The Example",
  "bio": "Just an example user.",
  "avatar": "https://static.paratranz.cn/media/xxxxxaaaaabbbbb"
}
```
```

--------------------------------

### Get Project Scores

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of scores for a specific project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/scores

### Description
This endpoint retrieves a paginated list of scores associated with a specific project. It allows for specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/scores`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/scores?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of score objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 100,
    "pageCount": 2,
    "results": [
      {
        "userId": 1,
        "score": 100
      }
    ]
  }
}
```
```

--------------------------------

### GET /history

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves historical records related to projects, users, or specific entries. Requires at least one of `project`, `uid`, or `tid` to be specified.

```APIDOC
## GET /history

### Description
Get history records for projects, users, or entries.

### Method
GET

### Endpoint
`/history`

### Query Parameters
*   **page** (integer) - Optional - The page number for pagination.
*   **pageSize** (integer) - Optional - The number of items per page.
*   **project** (integer) - Optional - Filter by project ID.
*   **uid** (integer) - Optional - Filter by user ID.
*   **tid** (integer) - Optional - Filter by entry ID (used when `type` is `text`). Pagination is disabled when `tid` is specified.
*   **type** (string) - Required (if `project`, `uid`, or `tid` are not present) - The type of history record. Options:
    *   `text`: Entry history.
    *   `import`: Import history (use with `project`).
    *   `comment`: Comment history (use with `project` or `uid`).

### Responses
#### Success Response (200)
*   **history** (array) - A list of history record objects.
    *   **id** (integer) - History record ID.
    *   **type** (string) - Type of record.
    *   **created_at** (string) - Timestamp of the record.
    *   Details specific to the history type (e.g., user, project, entry information).

#### Response Example (200)
```json
{
  "history": [
    {
      "id": 501,
      "type": "text",
      "created_at": "2023-01-04T14:00:00Z",
      "user": {"id": 1, "username": "user1"},
      "project": {"id": 1, "name": "My Project"},
      "entry": {"id": 101, "key": "greeting"}
    }
  ]
}
```

#### Error Response (400)
Bad Request - At least one of `project`, `uid`, or `tid` must be provided.
```

--------------------------------

### Get File History List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of historical revisions for files within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/files/history

### Description
This endpoint retrieves a paginated list of historical revisions for files within a specific project. It supports specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/files/history`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/files/history?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of file history objects.

#### Response Example
```json
{
  "example": [
    {
      "revisionId": 501,
      "fileId": 789,
      "version": "v1.1",
      "changedAt": "2023-10-27T11:00:00Z",
      "userId": 456
    }
  ]
}
```
```

--------------------------------

### Get Project Terms List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of terms associated with a specific project. Supports pagination using 'page' and 'pageSize' query parameters. This operation is part of the Terms API.

```json
{
  "/projects/{projectId}/terms": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      },
      {
        "$ref": "#/components/parameters/page"
      },
      {
        "$ref": "#/components/parameters/pageSize"
      }
    ],
    "get": {
      "operationId": "getTerms",
      "summary": "术语列表",
      "description": "获取项目术语列表",
      "tags": [
        "Terms"
      ],
      "responses": {
        "200": {
          "$ref": "#/components/responses/TermList"
        }
      }
    }
  }
}
```

--------------------------------

### Get Term History List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of historical revisions for terms within a project, with pagination support.

```APIDOC
## GET /websites/projects/{projectId}/terms/history

### Description
This endpoint retrieves a paginated list of historical revisions for terms within a specific project. It supports specifying the page number and the number of items per page.

### Method
GET

### Endpoint
`/websites/projects/{projectId}/terms/history`

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 50. Minimum 1, Maximum 800.

### Request Example
```json
{
  "example": "GET /websites/projects/123/terms/history?page=1&pageSize=20"
}
```

### Response
#### Success Response (200)
- **page** (integer) - The current page number.
- **pageSize** (integer) - The number of items per page.
- **rowCount** (integer) - The total number of items available.
- **pageCount** (integer) - The total number of pages.
- **results** (array) - An array of term history objects.

#### Response Example
```json
{
  "example": {
    "page": 1,
    "pageSize": 50,
    "rowCount": 300,
    "pageCount": 6,
    "results": [
      {
        "historyId": 301,
        "termId": 201,
        "oldValue": "translation",
        "newValue": "localization",
        "changedAt": "2023-10-27T10:00:00Z",
        "userId": 456
      }
    ]
  }
}
```
```

--------------------------------

### Get Term Information by ID

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves detailed information about a specific term within a project using its unique ID. This is part of the Terms API.

```json
{
  "/projects/{projectId}/terms/{termId}": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      },
      {
        "$ref": "#/components/parameters/termId"
      }
    ],
    "get": {
      "operationId": "getTerm",
      "summary": "术语信息",
      "description": "通过ID获取项目术语信息",
      "tags": [
        "Terms"
      ],
      "responses": {
        "200": {
          "$ref": "#/components/responses/TermItem"
        }
      }
    }
  }
}
```

--------------------------------

### Get Project Member List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of members associated with a specific project. This operation is part of the Members API.

```json
{
  "/projects/{projectId}/members": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      }
    ],
    "get": {
      "operationId": "getMembers",
      "summary": "成员列表",
      "description": "获取项目成员列表",
      "tags": [
        "Members"
      ],
      "responses": {
        "200": {
          "$ref": "#/components/responses/MemberList"
        }
      }
    }
  }
}
```

--------------------------------

### Get Project Issues List

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves a list of discussions or issues within a project. Supports filtering by 'status' (0 for open, 1 for closed). This endpoint is part of the Issues API.

```json
{
  "/projects/{projectId}/issues": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      }
    ],
    "get": {
      "operationId": "getIssues",
      "tags": [
        "Issues"
      ],
      "summary": "讨论列表",
      "description": "获取讨论列表",
      "parameters": [
        {
          "in": "query",
          "name": "status",
          "description": "按状态筛选讨论（0 - 讨论中，1 - 已关闭）",
          "schema": {
            "enum": [
              0,
              1
            ]
          }
        }
      ],
      "responses": {
        "200": {
          "$ref": "#/components/responses/IssueList"
        }
      }
    }
  }
}
```

--------------------------------

### POST /projects

Source: https://paratranz.cn/api-docs/index_format=json

Creates a new project for the authenticated user.

```APIDOC
## POST /projects

### Description
Create a new project.

### Method
POST

### Endpoint
`/projects`

### Request Body
*   **name** (string) - Required - The name of the project.
*   **description** (string) - Optional - A description for the project.

### Request Example
```json
{
  "name": "New Project",
  "description": "Details about the new project."
}
```

### Responses
#### Success Response (201)
*   **id** (integer) - The ID of the newly created project.
*   **name** (string) - The name of the project.
*   **description** (string) - The description of the project.
*   **created_at** (string) - Timestamp of creation.
*   **updated_at** (string) - Timestamp of last update.

#### Response Example (201)
```json
{
  "id": 2,
  "name": "New Project",
  "description": "Details about the new project.",
  "created_at": "2023-01-02T11:00:00Z",
  "updated_at": "2023-01-02T11:00:00Z"
}
```
#### Error Response (400)
Bad Request - Data is invalid.

#### Error Response (403)
Forbidden - User does not have permission to create projects.
```

--------------------------------

### OpenAPI Specification Download

Source: https://paratranz.cn/api-docs/index_format=json

The API documentation adheres to the OpenAPI specification. You can download the full API specification in JSON or YAML format. These formats are machine-readable and can be used with tools like OpenAPI Generator to automatically create client SDKs for various programming languages.

```html
[Get JSON format](/api-docs?format=json) or [YML format](/api-docs?format=yml) of the documentation
```

--------------------------------

### GET /mails/conversations/{userId}

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves the conversation history with a specific user.

```APIDOC
## GET /mails/conversations/{userId}

### Description
Retrieves the conversation history with a specific user.

### Method
GET

### Endpoint
/mails/conversations/{userId}

### Parameters
#### Path Parameters
- **userId** (integer) - Required - The ID of the user to retrieve the conversation with.

### Response
#### Success Response (200)
- **Conversation** (object) - The conversation history.

#### Response Example
```json
{
  "messages": [
    {
      "id": 1,
      "fromUserId": 1,
      "toUserId": 2,
      "subject": "Hello",
      "content": "Hi there!",
      "createdAt": "2023-10-27T10:00:00Z"
    },
    {
      "id": 2,
      "fromUserId": 2,
      "toUserId": 1,
      "subject": "Re: Hello",
      "content": "Hello back!",
      "createdAt": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

--------------------------------

### Download Exported Artifacts

Source: https://paratranz.cn/api-docs/index_format=json

Provides a link to download the compressed artifact package that has been exported from the project. This is typically a redirect to the actual download URL.

```json
{
  "/projects/{projectId}/artifacts/download": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      }
    ],
    "get": {
      "operationId": "downloadArtifact",
      "tags": [
        "Artifacts"
      ],
      "summary": "下载",
      "description": "下载导出的压缩包",
      "responses": {
        "302": {
          "description": "重定向至压缩包链接"
        }
      }
    }
  }
}
```

--------------------------------

### File

Source: https://paratranz.cn/api-docs/index_format=json

Represents a file within a project.

```APIDOC
## GET /file/{id}

### Description
Retrieves details of a specific file within a project.

### Method
GET

### Endpoint
/file/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the file to retrieve.

### Response
#### Success Response (200)
- **File** - Object representing a file.

#### Response Example
{
  "example": "{\"id\": 421, \"createdAt\": \"2021-01-11T03:19:52.818Z\", \"updatedAt\": \"2021-01-11T03:19:52.818Z\", \"modifiedAt\": \"2021-01-11T03:19:52.818Z\", \"name\": \"path/to/filename.csv\", \"project\": 1, \"format\": \"csv\", \"total\": 1453, \"translated\": 1452, \"disputed\": 2, \"checked\": 841, \"reviewed\": 100}"
}
```

--------------------------------

### Authentication and Usage

Source: https://paratranz.cn/api-docs/index_format=json

To interact with the ParaTranz API, you first need to obtain an API Token from your profile settings. This token should be included in the `Authorization` header of your requests as a Bearer token.

```APIDOC
## Authentication

### Get API Token
Obtain your API Token from the 'Settings' tab in your profile page.

### Request Header
Include the token in the `Authorization` header:

    Authorization: Bearer {TOKEN}

### cURL Example

    $ curl --header "Authorization: Bearer {TOKEN}" https://paratranz.cn/api/projects
```

--------------------------------

### Project Schema

Source: https://paratranz.cn/api-docs/index_format=json

Defines the structure for a project within the Paratranz system.

```APIDOC
## Project Schema

### Description
Represents a project in the Paratranz platform, including its metadata, settings, and ownership.

### Properties
- **id** (`integer`): Project ID. (Read-only)
- **createdAt** (`Datetime`): Project creation timestamp.
- **updatedAt** (`Datetime`): Project last update timestamp. (Nullable)
- **uid** (`integer`): User ID of the project owner. (Read-only)
- **user** (`object`): Information about the project owner. (Read-only)
- **name** (`string`): Name of the project.
- **logo** (`string`): URL of the project's logo. (Format: uri)
- **desc** (`string`): Description of the project.
- **source** (`string`): Source language of the project.
- **dest** (`string`): Target language of the project.
- **members** (`integer`): Number of members in the project. (Read-only)
- **game** (`string`): Associated game or application. (Example: "ck2")
- **license** (`string`): Project's license information. (Read-only)
- **activeLevel** (`number`): Project activity level. (Read-only)
- **stage** (`integer`): Project status stage.
- **privacy** (`integer`): Project privacy setting.
  - `0`: Public
  - `1`: Internal (Public project, private activity/files)
  - `2`: Private
- **download** (`integer`): Download permission setting.
  - `0`: Public
  - `1`: Internal
  - `2`: Private
- **issueMode** (`integer`): Discussion/issue tracking permission setting.
  - `0`: Public (Anyone can create/join discussions)
  - `1`: Internal (Only project members can create discussions, anyone can join)
  - `2`: Private (Only project members can create/join discussions)
- **reviewMode** (`integer`): Review level required for translations.
  - `0`: No review required
  - `1`: Single review
  - `2`: Double review
- **joinMode** (`integer`): How users can join the project.
  - `0`: Public (Anyone can join directly)
  - `1`: Application (Requires application)
  - `2`: Test (Requires passing a test)
  - `3`: Private (Only administrators can add members)
```

--------------------------------

### Artifacts API

Source: https://paratranz.cn/api-docs/index_format=json

Endpoints for managing project artifacts, including triggering exports, downloading artifacts, and retrieving export results.

```APIDOC
## GET /projects/{projectId}/artifacts

### Description
Retrieves the result of the most recent export operation for the project.

### Method
GET

### Endpoint
/projects/{projectId}/artifacts

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **Artifact** (object) - The result of the export. (Schema reference: #/components/schemas/Artifact)

## POST /projects/{projectId}/artifacts

### Description
Manually triggers an export operation for the project. Only administrators can use this endpoint.

### Method
POST

### Endpoint
/projects/{projectId}/artifacts

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project.

### Response
#### Success Response (200)
- **Job** (object) - Details about the initiated export job. (Schema reference: #/components/schemas/Job)
#### Error Response (403)
- Indicates lack of permissions.

## GET /projects/{projectId}/artifacts/download

### Description
Initiates the download of the exported artifact (compressed file).

### Method
GET

### Endpoint
/projects/{projectId}/artifacts/download

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project.

### Response
#### Success Response (302)
- **description** (string) - Redirects to the download link for the compressed artifact.

```

--------------------------------

### GET /projects/{projectId}/scores

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves the contribution scores for members within a project.

```APIDOC
## GET /projects/{projectId}/scores

### Description
Retrieves the contribution scores for members within a project.

### Method
GET

### Endpoint
/projects/{projectId}/scores

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.

#### Query Parameters
- **uid** (integer) - Optional - Filter by user ID (must be >= 1).
- **operation** (string) - Optional - Filter by operation type: `translate`, `edit`, or `review`.
- **start** (string) - Optional - Filter by start date-time.
- **end** (string) - Optional - Filter by end date-time.
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.

### Response
#### Success Response (200)
- **ScoreList** (object) - A list of member contributions.

#### Response Example
```json
{
  "total": 10,
  "contributions": [
    {
      "userId": 1,
      "username": "UserA",
      "translateCount": 100,
      "editCount": 50,
      "reviewCount": 25
    }
  ]
}
```
```

--------------------------------

### Add New Member to Project

Source: https://paratranz.cn/api-docs/index_format=json

Adds a new member to a project. This operation requires administrator privileges and a JSON request body conforming to the 'Member' schema.

```json
{
  "post": {
    "operationId": "createMember",
    "summary": "创建成员",
    "description": "加入新成员。需管理员以上权限",
    "tags": [
      "Members"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Member"
          }
        }
      }
    },
    "responses": {
      "200": {
        "$ref": "#/components/responses/MemberItem"
      }
    }
  }
}
```

--------------------------------

### GET /projects/{projectId}/issues/{issueId}

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves the details of a specific discussion thread by its ID.

```APIDOC
## GET /projects/{projectId}/issues/{issueId}

### Description
Retrieves the details of a specific discussion thread by its ID.

### Method
GET

### Endpoint
/projects/{projectId}/issues/{issueId}

### Parameters
#### Path Parameters
- **projectId** (integer) - Required - The ID of the project.
- **issueId** (integer) - Required - The ID of the issue.

### Response
#### Success Response (200)
- **IssueItem** (object) - The details of the requested issue.

#### Response Example
```json
{
  "id": 123,
  "projectId": 867,
  "title": "Example Issue Title",
  "content": "This is the content of the issue.",
  "status": "open"
}
```
```

--------------------------------

### Create New Project Term

Source: https://paratranz.cn/api-docs/index_format=json

Creates a new term within a project. If a term with the same identifier already exists, the operation will fail. Requires a JSON request body conforming to the 'Term' schema.

```json
{
  "post": {
    "operationId": "createTerm",
    "summary": "创建术语",
    "description": "创建新术语，如果已存在相同术语会失败",
    "tags": [
      "Terms"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Term"
          }
        }
      }
    },
    "responses": {
      "200": {
        "$ref": "#/components/responses/TermItem"
      }
    }
  }
}
```

--------------------------------

### File Upload API

Source: https://paratranz.cn/api-docs/index_format=json

Handles the upload of files to a project. This endpoint is designed for initial file uploads and can accept files in various formats, including standard JSON.

```APIDOC
## POST /projects/{projectId}/files

### Description
Uploads a file to the specified project.

### Method
POST

### Endpoint
`/projects/{projectId}/files`

### Parameters
#### Path Parameters
- **projectId** (string) - Required - The ID of the project to upload the file to.

#### Request Body
- **file** (file) - Required - The file data to upload. This can be a binary file or a JSON file with the original filename appended with `.json`.

### Request Example
(No example provided in the source)

### Response
#### Success Response (200)
- **file** (File Object) - Information about the uploaded file.
- **revision** (Revision Object) - Information about the revision of the uploaded file.

#### Response Example
```json
{
  "file": { ... },
  "revision": { ... }
}
```
```

--------------------------------

### Import Terms via JSON File

Source: https://paratranz.cn/api-docs/index_format=json

Imports terms into a project in bulk by uploading a JSON file. The JSON file should contain an array of term objects, each with 'term', 'translation', 'pos', 'note', and optional 'variants' properties. Returns counts of inserted, updated, and deleted terms.

```json
{
  "put": {
    "operationId": "importTerms",
    "summary": "批量导入术语",
    "description": "上传JSON文件批量导入术语",
    "tags": [
      "Terms"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "multipart/form-data": {
          "schema": {
            "type": "object",
            "properties": {
              "file": {
                "type": "string",
                "description": "JSON文件数据，示例如下\n```  [\n    {\n      \"term\": \"apple\",\n      \"translation\": \"苹果\",\n      \"pos\": \"noun\",\n      \"note\": \"注释\",\n      \"variants\": [\"apples\"]\n    }\n  ]\n```\n",
                "format": "binary"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "术语导入成功",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "inserted": {
                  "type": "integer",
                  "description": "新创建的术语数量"
                },
                "updated": {
                  "type": "integer",
                  "description": "已更新的术语数量"
                },
                "deleted": {
                  "type": "integer",
                  "description": "已删除的术语数量"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Get Latest Artifact Export Result

Source: https://paratranz.cn/api-docs/index_format=json

Retrieves the result of the most recent artifact export for a project. The response contains details about the export.

```json
{
  "/projects/{projectId}/artifacts": {
    "parameters": [
      {
        "$ref": "#/components/parameters/projectId"
      }
    ],
    "get": {
      "operationId": "getArtifact",
      "tags": [
        "Artifacts"
      ],
      "summary": "导出结果",
      "description": "获取最近一次导出的结果",
      "responses": {
        "200": {
          "description": "返回结果",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Artifact"
              }
            }
          }
        }
      }
    }
  }
}
```
Tokens:
Raw