Wimi Pro WAPI

https://pegasus.wimi.pro/wapi-doc-api
Admin
Wimi Pro WAPI is a comprehensive REST API documentation for project management, collaboration, and...
Tokens:648,892
Snippets:1,945
Trust Score:7.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Get Notification Settings (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example demonstrates the JSON structure for requesting account notification settings. It requires account_id and user_id in the header.

```json
{
    "header": {
        "target": "main.account.GetNotificationSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Project Templates API Request Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example demonstrates the JSON structure for requesting project templates from the Wimi Pro API. It includes essential header information for authentication and identification.

```json
{
    "header": {
        "target": "main.account.GetProjectTemplates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Project Templates (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This snippet provides an example JSON request for retrieving project templates for an account. The API call is sent in the HTTP request body.

```json
{
    "header": {
        "target": "main.account.GetProjectTemplates",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login"
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Project Details (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example illustrates how to request detailed information about a user's project. It includes optional parameters like project_auth, project_stats, and project_users in the body, and requires project_id in the header.

```json
{
    "header": {
        "target": "main.account.GetProject",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "project_auth": true,
            "project_stats": true,
            "project_users": true
        }
    }
}
```

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

### POST main.account.SetOnBoardingInfo

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Sets the onboarding information for the account, potentially including welcome messages or initial setup instructions.

```APIDOC
## POST main.account.SetOnBoardingInfo

### Description
Sets the onboarding info for the account.

### Method
POST

### Endpoint
/main/account/SetOnBoardingInfo

### Parameters
#### Request Body
- **onboarding_info** (object) - Required - An object containing onboarding details.

### Request Example
```json
{
  "onboarding_info": {
    "welcome_message": "Welcome to Wimi!"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - 'success' or an error message.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### Get File Download Token - JSON Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example shows the structure for requesting a download token for a file. It requires authentication and project identification in the header, with an empty data object in the body.

```json
{
    "header": {
        "target": "document.file.GetDownloadToken",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get File Properties Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example shows how to request the properties of a file. It requires 'account_id', 'user_id', and 'project_id' in the header, along with either 'file_id' or 'file_id_list'. The function is rate-limited and project-restricted.

```json
{
    "header": {
        "target": "document.file.GetProperties",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Personalized Entries Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Example JSON payload for retrieving personalized entries via the main.personalizedentry.GetPersonalizedEntries API. It requires authentication and identification details in the header.

```json
{
    "header": {
        "target": "main.personalizedentry.GetPersonalizedEntries",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Project Tree - JSON Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example shows the JSON request for retrieving a flat project tree. It requires account, user, and project IDs in the header, with an empty data object in the body.

```json
{
    "header": {
        "target": "document.entry.GetProjectTree",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Directory (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example illustrates how to retrieve directory information using its ID. The request includes account, user, and directory IDs in the header. The response will contain the directory details if successful.

```json
{
    "header": {
        "target": "document.directory.Get",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "dir_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get List of Meetings - JSON Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example demonstrates how to request a list of meetings using the `meeting.meeting.GetList` endpoint. It requires `account_id`, `user_id`, and `project_id` in the header. This route is project-restricted and rate-limited.

```json
{
    "header": {
        "target": "meeting.meeting.GetList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Linked Item List Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example illustrates how to request a list of linked items. It includes account and user identification, and importantly, specifies the 'item' for which linked items are to be retrieved.

```json
{
    "header": {
        "target": "main.item.GetLinkedItemList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "item": {
                "item_type_id": "3",
                "item_id": "12345"
            }
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get File Properties List Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example illustrates the request format for fetching properties of a specific file using the document.file.GetPropertyList API. It requires project and file master ID in the header for identification.

```json
{
    "header": {
        "target": "document.file.GetPropertyList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_master_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get File Versions Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON payload is an example for the document.file.GetVersions API, used to retrieve a list of versions for a given file. The header includes essential identification parameters like account, user, project, and file IDs.

```json
{
    "header": {
        "target": "document.file.GetVersions",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Set User Notification Settings Request Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Provides an example of the JSON payload for setting user notification preferences. It specifies the target API, authentication details, and user identification in the header. The body contains data for enabling or disabling notifications for various channels like documents, tasks, and calendar events.

```json
{
    "header": {
        "target": "main.user.SetNotificationSettings",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "channel": 12345,
            "documents": 12345,
            "tasks": 12345,
            "calendar": 12345,
            "meetings": 12345
        }
    }
}
```

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

### Wimi API: ConversationArchive Request Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Example JSON payload for archiving a conversation using the link.link.ConversationArchive endpoint. Requires project-specific and role-based authorization.

```JSON
{
    "header": {
        "target": "link.link.ConversationArchive",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Add Tag to Calendar Event (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example illustrates how to add a tag to a calendar event. It requires project and calendar event identification, along with the label for the tag.

```json
{
    "header": {
        "target": "calendar.event.AddTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345,
            "label": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Add Armored Chat (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Example JSON payload for adding an armored chat. This includes header information such as target API, version, authentication tokens, and identification details like account and user IDs.

```json
{
    "header": {
        "target": "armoured.armoured.AddArmouredChat",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "chat_id": 12345,
            "session_id": "mylabel1"
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### GET main.account.ListProperties

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Retrieves all the properties associated with the account. This can include custom settings or metadata.

```APIDOC
## GET main.account.ListProperties

### Description
Gets all account properties.

### Method
GET

### Endpoint
/main/account/ListProperties

### Parameters
#### Query Parameters
- **account_id** (integer) - Required - The ID of the account.

### Request Example
```json
{
  "account_id": 98765
}
```

### Response
#### Success Response (200)
- **properties** (array) - An array of property objects.

#### Response Example
```json
[
  {
    "name": "property1",
    "value": "value1"
  }
]
```
```

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

### Wimi API: Import Task List from CSV Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON structure demonstrates an example request for importing tasks and lists from a CSV file using the task.tlist.ImportFromCSV endpoint. It requires header authentication details and identification for the project. The body contains data such as the file name and size, with the actual file content sent in the HTTP request body.

```json
{
    "header": {
        "target": "task.tlist.ImportFromCSV",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {
            "name": "some text",
            "size": 12345
        }
    }
}
```

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

### Unshare Item Endpoint Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example demonstrates the payload for the sharing.personal.UnshareItem endpoint, which is used to stop sharing a specific item. The header contains necessary authentication and identification parameters.

```json
{
    "header": {
        "target": "sharing.personal.UnshareItem",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Tutorial Info (API Request Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example demonstrates a request to the main.account.GetTutorialInfo endpoint. It's used to fetch data necessary for displaying a welcome tutorial to users. The request includes standard header fields and an empty data body.

```json
{
    "header": {
        "target": "main.account.GetTutorialInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get or Create Persistent Room Request Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

An example JSON request payload for the communication.air.GetOrCreatePersistentRoom API. This request is used to get an existing persistent room or create a new one if it doesn't exist.

```json
{
    "header": {
        "target": "communication.air.GetOrCreatePersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "room_id": 12345,
            "community_id": 12345
        }
    }
}
```

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

### Update Mailbox Password Request Example (Node.js)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example shows the JSON payload for updating a mailbox password, specifically implemented in Node.js. It requires mailbox identification along with the new password.

```json
{
    "header": {
        "target": "mail.mailbox.UpdateMailboxPassword",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "mailbox_id": 12345
        }
    },
    "body": {
        "data": {
            "password": "mypassword"
        }
    }
}
```

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

### Example JSON for Deleting a Project

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON structure is used to send a request for deleting a project via the Wimi.pro API. It requires authentication and project identification in the header, with an empty body as the action is defined by the target.

```json
{
    "header": {
        "target": "main.project.Delete",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Unshare Endpoint Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON payload is an example for the sharing.personal.Unshare endpoint, used to revoke sharing permissions for an item. It includes comprehensive identification details in the header.

```json
{
    "header": {
        "target": "sharing.personal.Unshare",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_id_list": [
                12345,
                12346
            ],
            "item": {
                "item_type_id": "3",
                "item_id": "12345"
            }
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get File IPTC Metadata - JSON Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example outlines the request for retrieving IPTC metadata of a file. Similar to other GET requests, it requires authentication and identification in the header and an empty data object in the body.

```json
{
    "header": {
        "target": "document.file.GetIPTCMetadata",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Move Choice Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

JSON payload for the main.personalizedentry.MoveChoice API, used to reposition a choice within an entry. This API call requires authentication and specifies the entry, choice, and new position in the body.

```json
{
    "header": {
        "target": "main.personalizedentry.MoveChoice",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "entry_id": 12345,
            "choice_id": 12345,
            "position": 10
        }
    }
}
```

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

### Download Comment External Attachment API Request Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

A sample JSON request for downloading an external attachment of a comment. The header includes essential identification details and the specific `attachment_file_id`.

```json
{
    "header": {
        "target": "document.file.DownloadCommentExternalAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "attachment_file_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### GET main.account.GetTutorialInfo

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Returns the necessary information to display the welcome tutorial to the user, including tutorial steps and relevant content.

```APIDOC
## GET main.account.GetTutorialInfo

### Description
Returns the information required to display the welcome tutorial.

### Method
GET

### Endpoint
/main/account/GetTutorialInfo

### Parameters
#### None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **tutorial_info** (object) - An object containing tutorial information.

#### Response Example
```json
{
  "steps": [
    {
      "step_number": 1,
      "content": "Welcome to the tutorial!"
    }
  ]
}
```
```

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

### Remove Tag from Link by ID (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example demonstrates the JSON structure for removing a specific tag from a link using its ID. It necessitates providing account, user, project, and link identifiers, along with the tag ID to be removed. The response indicates success and returns the updated link and tag information.

```json
{
    "header": {
        "target": "link.link.RemoveTag",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345,
            "tag_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Set Onboarding Info API Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Example JSON payload for the main.account.SetOnBoardingInfo API. This request is used to configure initial onboarding details for a user or account, such as company name, size, and user preferences. It requires authentication and identification.

```json
{
    "header": {
        "target": "main.account.SetOnBoardingInfo",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "company_name": "some text",
            "company_size": "some text",
            "welcome_invite_wish": "value",
            "welcome_activity": "some text",
            "welcome_interest": 12345,
            "welcome_usage_cases": [
                "string1",
                "string2",
                "string3"
            ],
            "welcome_discover_wimi": "value",
            "entity_type": "mylabel1"
        }
    }
}
```

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

### Get Persistent Room Request Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

An example JSON request payload for the communication.air.GetPersistentRoom API. This request is used to retrieve details of a specific persistent airtime room.

```json
{
    "header": {
        "target": "communication.air.GetPersistentRoom",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {
            "room_id": 12345
        }
    }
}
```

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

### Add Comment to External Attachment on Calendar Event (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example illustrates the JSON payload for adding a comment to an external attachment associated with a calendar event. It details the required header fields for identification and authentication, and the body data for the comment and attachment.

```json
{
    "header": {
        "target": "calendar.event.AddExternalAttachmentComment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {
            "attachment_title": "some text",
            "attachment_description": "some text",
            "name": "some text",
            "size": 12345
        }
    }
}
```

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

### document.directory.PromoteToProject

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Creates a new project from an existing directory.

```APIDOC
## document.directory.PromoteToProject

### Description
Creates a project from a directory.

### Method
POST

### Endpoint
https://api.wimi.pro

### Call Type
JSON message sent in the HTTP request body.

### Target Information
- **Target**: `document.directory.PromoteToProject`
- **Stream Value**: Pushing on document stream (8) and on document tree stream (16).

### Request Body
*(Specific request body structure not detailed in the provided text, but typically includes identification headers similar to other endpoints.)*

### Response
*(Success and error response details not provided in the input text.)*

### Restrictions
*(Specific restrictions not detailed in the provided text, but likely involves user roles and permissions.)*
```

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

### Clear Unseen Conversation Count - JSON Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example demonstrates how to clear the unseen message count for a conversation. It requires header identification including account, user, project, and calendar event IDs. The 'target' is specified as 'calendar.event.ConversationClearUnseen'.

```JSON
{
    "header": {
        "target": "calendar.event.ConversationClearUnseen",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "calendar_event_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### GET /main.account.GetUserProjectsAuth

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Retrieves the project authorization details for a specified user within an account. This endpoint requires specific header identification and allows for role-based access control.

```APIDOC
## GET /main.account.GetUserProjectsAuth

### Description
Retrieves project authorization information for a given user. This endpoint is subject to rate limitations and role restrictions.

### Method
GET

### Endpoint
/main.account.GetUserProjectsAuth

### Parameters
#### Header Parameters
- **account_id** (int) - Required - The ID of the account.
- **user_id** (int) - Required - The ID of the user making the request.
- **target_user_id** (int) - Required - The ID of the user whose projects are being queried.

### Request Example
```json
{
    "header": {
        "target": "main.account.GetUserProjectsAuth",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "target_user_id": 12346
        }
    },
    "body": {
        "data": {}
    }
}
```

### Response
#### Success Response (200)
- **user_id** (int) - The ID of the user.
- **projects_auth** (LIST of ProjectAuth) - A list of project authorization objects.

#### Response Example
```json
{
  "status": "success",
  "msg_key": "unique_message_key",
  "data": {
    "user_id": 12346,
    "projects_auth": [
      {
        "project_id": "proj_123",
        "project_name": "Project Alpha",
        "permissions": ["read", "write"]
      }
    ]
  }
}
```
```

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

### Preview Attachment API Request Example

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON structure represents a request to preview an attachment. The call type indicates that the JSON message is sent in the HTTP request body. Further details on specific parameters and restrictions for this endpoint are not provided in the snippet.

```json
{
    "header": {
        "target": "link.link.PreviewAttachment",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345,
            "link_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### GET main.account.GetVATForCountryCode

Source: https://pegasus.wimi.pro/wapi-doc-api/index

Retrieves VAT (Value Added Tax) information based on a provided country code. This aids in tax calculations.

```APIDOC
## GET main.account.GetVATForCountryCode

### Description
Gets VAT information for a given country code.

### Method
GET

### Endpoint
/main/account/GetVATForCountryCode

### Parameters
#### Query Parameters
- **country_code** (string) - Required - The two-letter country code (e.g., 'US', 'FR').

### Request Example
```json
{
  "country_code": "FR"
}
```

### Response
#### Success Response (200)
- **vat_info** (object) - An object containing VAT details.

#### Response Example
```json
{
  "rate": 0.2
}
```
```

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

### Download File for Preview (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This example demonstrates the JSON structure for requesting a file download for preview. It includes header information such as target API, version, authentication tokens, and identification details. The body contains minimal data for this operation.

```json
{
    "header": {
        "target": "document.file.DownloadForPreviewInternal",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Get Project Document Size (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example shows the request format for retrieving the document size of a user's project. It requires project_id in the header.

```json
{
    "header": {
        "target": "main.account.GetProjectDocumentSize",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "project_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Create Project Request (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example outlines the structure for creating a new project. It includes header information and a detailed body object for specifying project name, category, notification settings, and cloning options. Optional parameters allow for customization during project creation.

```json
{
    "header": {
        "account_id": 12345,
        "user_id": 12345,
        "api_key": "optional_api_key",
        "clone_project_id": null
    },
    "body": {
        "project_name": "My New Project",
        "category_id": 0,
        "new_category_name": "",
        "no_email": false,
        "email_prefix": "",
        "info": "",
        "url_image": "",
        "template_key": "",
        "clone_directories": true,
        "clone_files": true,
        "clone_tasks": true,
        "business_hour_start_datetime": null,
        "business_hour_end_datetime": null,
        "business_hour_enable_weekend": 0,
        "add_creator_to_wd_sync": true,
        "add_event_creator_as_participant": 1,
        "default_auto_wd_sync": false
    }
}
```

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

### Get Community Discovery List Request JSON

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON payload is utilized to fetch a list of communities that a user can discover. It requires standard header authentication details, including account and user IDs. The 'data' field within the body is empty, indicating that the discovery list is generated based on the provided user identification.

```json
{
    "header": {
        "target": "social.community.GetDiscoveryList",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```

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

### Remove Member from Group (JSON Example)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This snippet demonstrates the JSON structure for removing a member from a user group. It includes header identification and body data specifying the member to be removed. This function is subject to rate limitations and requires specific user roles.

```json
{
    "header": {
        "target": "main.group.RemoveMember",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345,
            "user_group_id": 12345
        }
    },
    "body": {
        "data": {
            "group_member": {
                "member_type_id": 1,
                "member_id": 12345
            }
        }
    }
}
```

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

### Get Shared With Me Example (JSON)

Source: https://pegasus.wimi.pro/wapi-doc-api/index

This JSON example shows the request format for retrieving a list of items shared with the current user. It includes the necessary header information for authentication and identification.

```json
{
    "header": {
        "target": "sharing.personal.GetSharedWithMe",
        "api_version": "1.2",
        "app_token": "You can generate one from your account settings",
        "msg_key": "message key also returned in the response",
        "token": "user session token returned by auth.user.Login",
        "identification": {
            "account_id": 12345,
            "user_id": 12345
        }
    },
    "body": {
        "data": {}
    }
}
```
Tokens:
Raw