# Voltaserve API

- Files
  - postUpload
  - delDelete
  - getGet by ID
  - patchPatch
  - postCopy
  - postDelete OCR
  - getGet group permissions
  - getGet IDs
  - getGet children count
  - getGet path
  - getGet size
  - getGet user permissions
  - getListByID
  - postMove
  - getDownload OCR
  - getDownload original
  - getDownload preview
  - postRename
  - postRevoke group permission
  - postUpdate OCR language
  - postBatch delete
  - postBatch get
  - postUpdate snapshot
  - postCreate
  - getGet by Path
  - postGrant group permission
  - postGrant user permission
  - getListByPath
  - postRevoke user permission
  - postSearch
- Groups
  - getList
  - postCreate
  - delDelete
  - getGet by ID
  - postAdd member
  - postRemove member
  - postUpdate name
- Invitations
  - postCreate
  - delDelete
  - postAccept
  - postDelete
  - postResend
  - getGet incoming
  - getGet outgoing
- Notifications
  - getGet notifications
- OCRLanguages
  - getList
  - getGetAll
- Organizations
  - getList
  - postCreate
  - delDelete
  - getGet by ID
  - postLeave
  - postRemove member
  - postUpdate name
- Storage
  - getGet account usage
  - getGet file usage
  - getGet workspace usage
- Users
  - getList
- Workspaces
  - getList
  - postCreate
  - delDelete
  - getGet by ID
  - postUpdate is automatic OCR enabled
  - postUpdate name
  - postUpdate storage capacity

API docs by Redocly

# Voltaserve API (1.0.0)

Download OpenAPI specification:Download

# Files

## Upload

Upload

##### query Parameters

workspace_id required | string Workspace ID
parent_id | string Parent ID

### Responses

/v1/files

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Get by ID

Get by ID

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Patch

Patch

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Copy

Copy

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

ids required | Array of strings

### Responses

/v1/files/{id}/copy

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ]

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Delete OCR

Delete OCR

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/delete_ocr

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Get group permissions

Get group permissions

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_group_permissions

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- {
  - "group":
    {
    - "createTime": "string",
    - "id": "string",
    - "image": "string",
    - "name": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "permission": "string",
    - "updateTime": "string"
    },
  - "id": "string",
  - "permission": "string"
  }

]`

## Get IDs

Get IDs

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_ids

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- "string"

]`

## Get children count

Get children count

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_item_count

### Response samples

- 200
- 404
- 500

Content type
application/json
0
`0`

## Get path

Get path

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_path

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- {
  - "createTime": "string",
  - "id": "string",
  - "isShared": true,
  - "name": "string",
  - "ocr":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "original":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "parentId": "string",
  - "permission": "string",
  - "preview":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "snapshots":
    [
    - {
      - "id": "string",
      - "language": "string",
      - "ocr":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "original":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "preview":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "thumbnail":
        {
        - "base64": "string",
        - "height": 0,
        - "width": 0
        },
      - "version": 0
      }
    ],
  - "thumbnail":
    {
    - "base64": "string",
    - "height": 0,
    - "width": 0
    },
  - "type": "string",
  - "updateTime": "string",
  - "version": 0,
  - "workspaceId": "string"
  }

]`

## Get size

Get size

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_size

### Response samples

- 200
- 404
- 500

Content type
application/json
0
`0`

## Get user permissions

Get user permissions

##### path Parameters

id required | string ID

### Responses

/v1/files/{id}/get_user_permissions

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- {
  - "id": "string",
  - "permission": "string",
  - "user":
    {
    - "createTime": "string",
    - "email": "string",
    - "fullName": "string",
    - "id": "string",
    - "picture": "string",
    - "updateTime": "string",
    - "username": "string"
    }
  }

]`

## ListByID

ListByID

##### path Parameters

id required | string ID

##### query Parameters

type | string Type
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/files/{id}/list

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "id": "string",
    - "isShared": true,
    - "name": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "parentId": "string",
    - "permission": "string",
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "snapshots":
      [
      - {
        - "id": "string",
        - "language": "string",
        - "ocr":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "original":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "preview":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "thumbnail":
          {
          - "base64": "string",
          - "height": 0,
          - "width": 0
          },
        - "version": 0
        }
      ],
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "type": "string",
    - "updateTime": "string",
    - "version": 0,
    - "workspaceId": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## Move

Move

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

ids required | Array of strings

### Responses

/v1/files/{id}/move

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ]

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Download OCR

Download OCR

##### path Parameters

id required | string ID

##### query Parameters

access_token required | string Access Token

### Responses

/v1/files/{id}/ocr{ext}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Download original

Download original

##### path Parameters

id required | string ID

##### query Parameters

access_token required | string Access Token

### Responses

/v1/files/{id}/original{ext}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Download preview

Download preview

##### path Parameters

id required | string ID

##### query Parameters

access_token required | string Access Token

### Responses

/v1/files/{id}/preview{ext}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Rename

Rename

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

name required | string <= 255 characters

### Responses

/v1/files/{id}/rename

### Request samples

- Payload

Content type
application/json
`
{

- "name": "string"

}`

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Revoke group permission

Revoke group permission

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

groupId required | string
ids required | Array of strings

### Responses

/v1/files/{id}/revoke_group_permission

### Request samples

- Payload

Content type
application/json
`
{

- "groupId": "string",
- "ids":
  [
  - "string"
  ]

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Update OCR language

Update OCR language

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

id required | string

### Responses

/v1/files/{id}/update_ocr_language

### Request samples

- Payload

Content type
application/json
`
{

- "id": "string"

}`

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Batch delete

Batch delete

##### Request Body schema: application/json

Body

ids required | Array of strings

### Responses

/v1/files/batch_delete

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ]

}`

### Response samples

- 200
- 500

Content type
application/json
`
[

- "string"

]`

## Batch get

Batch get

##### Request Body schema: application/json

Body

ids required | Array of strings

### Responses

/v1/files/batch_get

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ]

}`

### Response samples

- 200
- 500

Content type
application/json
`
[

- {
  - "createTime": "string",
  - "id": "string",
  - "isShared": true,
  - "name": "string",
  - "ocr":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "original":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "parentId": "string",
  - "permission": "string",
  - "preview":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "snapshots":
    [
    - {
      - "id": "string",
      - "language": "string",
      - "ocr":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "original":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "preview":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "thumbnail":
        {
        - "base64": "string",
        - "height": 0,
        - "width": 0
        },
      - "version": 0
      }
    ],
  - "thumbnail":
    {
    - "base64": "string",
    - "height": 0,
    - "width": 0
    },
  - "type": "string",
  - "updateTime": "string",
  - "version": 0,
  - "workspaceId": "string"
  }

]`

## Update snapshot

Update snapshot

##### Request Body schema: application/json

Body

| object (model.S3Object)
| object (client.PipelineRunOptions)
| object (model.S3Object)
| object (model.S3Object)
| object (model.S3Object)
| object (model.Thumbnail)

### Responses

/v1/files/conversion_webhook/update_snapshot

### Request samples

- Payload

Content type
application/json
`
{

- "ocr":
  {
  - "bucket": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "key": "string",
  - "language": "string",
  - "size": 0
  },
- "options":
  {
  - "bucket": "string",
  - "fileId": "string",
  - "isAutomaticOcrEnabled": true,
  - "key": "string",
  - "ocrLanguageId": "string",
  - "snapshotId": "string"
  },
- "original":
  {
  - "bucket": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "key": "string",
  - "language": "string",
  - "size": 0
  },
- "preview":
  {
  - "bucket": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "key": "string",
  - "language": "string",
  - "size": 0
  },
- "text":
  {
  - "bucket": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "key": "string",
  - "language": "string",
  - "size": 0
  },
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  }

}`

### Response samples

- 401
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Create

Create

##### Request Body schema: application/json

Body

name required | string <= 255 characters
parentId | string
workspaceId required | string

### Responses

/v1/files/create_folder

### Request samples

- Payload

Content type
application/json
`
{

- "name": "string",
- "parentId": "string",
- "workspaceId": "string"

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Get by Path

Get by Path

##### path Parameters

id required | string ID

### Responses

/v1/files/get

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "isShared": true,
- "name": "string",
- "ocr":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "original":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "parentId": "string",
- "permission": "string",
- "preview":
  {
  - "extension": "string",
  - "image":
    {
    - "height": 0,
    - "width": 0
    },
  - "language": "string",
  - "size": 0
  },
- "snapshots":
  [
  - {
    - "id": "string",
    - "language": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "version": 0
    }
  ],
- "thumbnail":
  {
  - "base64": "string",
  - "height": 0,
  - "width": 0
  },
- "type": "string",
- "updateTime": "string",
- "version": 0,
- "workspaceId": "string"

}`

## Grant group permission

Grant group permission

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

groupId required | string
ids required | Array of strings
permission required | string Enum: "viewer" "editor" "owner"

### Responses

/v1/files/grant_group_permission

### Request samples

- Payload

Content type
application/json
`
{

- "groupId": "string",
- "ids":
  [
  - "string"
  ],
- "permission": "viewer"

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Grant user permission

Grant user permission

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

ids required | Array of strings
permission required | string Enum: "viewer" "editor" "owner"
userId required | string

### Responses

/v1/files/grant_user_permission

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ],
- "permission": "viewer",
- "userId": "string"

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## ListByPath

ListByPath

##### query Parameters

path required | string Path

### Responses

/v1/files/list

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- {
  - "createTime": "string",
  - "id": "string",
  - "isShared": true,
  - "name": "string",
  - "ocr":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "original":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "parentId": "string",
  - "permission": "string",
  - "preview":
    {
    - "extension": "string",
    - "image":
      {
      - "height": 0,
      - "width": 0
      },
    - "language": "string",
    - "size": 0
    },
  - "snapshots":
    [
    - {
      - "id": "string",
      - "language": "string",
      - "ocr":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "original":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "preview":
        {
        - "extension": "string",
        - "image":
          {
          - "height": 0,
          - "width": 0
          },
        - "language": "string",
        - "size": 0
        },
      - "thumbnail":
        {
        - "base64": "string",
        - "height": 0,
        - "width": 0
        },
      - "version": 0
      }
    ],
  - "thumbnail":
    {
    - "base64": "string",
    - "height": 0,
    - "width": 0
    },
  - "type": "string",
  - "updateTime": "string",
  - "version": 0,
  - "workspaceId": "string"
  }

]`

## Revoke user permission

Revoke user permission

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

ids required | Array of strings
userId required | string

### Responses

/v1/files/revoke_user_permission

### Request samples

- Payload

Content type
application/json
`
{

- "ids":
  [
  - "string"
  ],
- "userId": "string"

}`

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Search

Search

##### query Parameters

page required | string Page
size required | string Size

##### Request Body schema: application/json

Body

createTimeAfter | integer
createTimeBefore | integer
parentId | string
text required | string
type | string Enum: "file" "folder"
updateTimeAfter | integer
updateTimeBefore | integer
workspaceId required | string

### Responses

/v1/files/search

### Request samples

- Payload

Content type
application/json
`
{

- "createTimeAfter": 0,
- "createTimeBefore": 0,
- "parentId": "string",
- "text": "string",
- "type": "file",
- "updateTimeAfter": 0,
- "updateTimeBefore": 0,
- "workspaceId": "string"

}`

### Response samples

- 200
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "id": "string",
    - "isShared": true,
    - "name": "string",
    - "ocr":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "original":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "parentId": "string",
    - "permission": "string",
    - "preview":
      {
      - "extension": "string",
      - "image":
        {
        - "height": 0,
        - "width": 0
        },
      - "language": "string",
      - "size": 0
      },
    - "snapshots":
      [
      - {
        - "id": "string",
        - "language": "string",
        - "ocr":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "original":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "preview":
          {
          - "extension": "string",
          - "image":
            {
            - "height": 0,
            - "width": 0
            },
          - "language": "string",
          - "size": 0
          },
        - "thumbnail":
          {
          - "base64": "string",
          - "height": 0,
          - "width": 0
          },
        - "version": 0
        }
      ],
    - "thumbnail":
      {
      - "base64": "string",
      - "height": 0,
      - "width": 0
      },
    - "type": "string",
    - "updateTime": "string",
    - "version": 0,
    - "workspaceId": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

# Groups

## List

List

##### query Parameters

query | string Query
organization_id | string Organization ID
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/groups

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "id": "string",
    - "image": "string",
    - "name": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "permission": "string",
    - "updateTime": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## Create

Create

##### Request Body schema: application/json

Body

image | string
name required | string <= 255 characters
organizationId required | string

### Responses

/v1/groups

### Request samples

- Payload

Content type
application/json
`
{

- "image": "string",
- "name": "string",
- "organizationId": "string"

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "updateTime": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/groups/{id}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Get by ID

Get by ID

##### path Parameters

id required | string ID

### Responses

/v1/groups/{id}

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "updateTime": "string"

}`

## Add member

Add member

##### path Parameters

id required | string ID

### Responses

/v1/groups/{id}/add_member

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Remove member

Remove member

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

userId required | string

### Responses

/v1/groups/{id}/remove_member

### Request samples

- Payload

Content type
application/json
`
{

- "userId": "string"

}`

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Update name

Update name

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

name required | string <= 255 characters

### Responses

/v1/groups/{id}/update_name

### Request samples

- Payload

Content type
application/json
`
{

- "name": "string"

}`

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "updateTime": "string"

}`

# Invitations

## Create

Create

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

emails required | Array of strings
organizationId required | string

### Responses

/v1/invitations

### Request samples

- Payload

Content type
application/json
`
{

- "emails":
  [
  - "string"
  ],
- "organizationId": "string"

}`

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/invitations/{id}

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Accept

Accept

##### path Parameters

id required | string ID

### Responses

/v1/invitations/{id}/accept

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/invitations/{id}/decline

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Resend

Resend

##### path Parameters

id required | string ID

### Responses

/v1/invitations/{id}/resend

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Get incoming

Get incoming

##### query Parameters

page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/invitations/get_incoming

### Response samples

- 200
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "email": "string",
    - "id": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "owner":
      {
      - "createTime": "string",
      - "email": "string",
      - "fullName": "string",
      - "id": "string",
      - "picture": "string",
      - "updateTime": "string",
      - "username": "string"
      },
    - "status": "string",
    - "updateTime": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## Get outgoing

Get outgoing

##### query Parameters

organization_id required | string Organization ID
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/invitations/get_outgoing

### Response samples

- 200
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "email": "string",
    - "id": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "owner":
      {
      - "createTime": "string",
      - "email": "string",
      - "fullName": "string",
      - "id": "string",
      - "picture": "string",
      - "updateTime": "string",
      - "username": "string"
      },
    - "status": "string",
    - "updateTime": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

# Notifications

## Get notifications

Get notifications

### Responses

/v1/notifications

### Response samples

- 200

Content type
application/json
`
[

- {
  - "body": null,
  - "type": "string"
  }

]`

# OCRLanguages

## List

List

##### query Parameters

query | string Query
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/ocr_languages

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "id": "string",
    - "iso639pt3": "string",
    - "name": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## GetAll

GetAll

### Responses

/v1/ocr_languages/all

### Response samples

- 200
- 404
- 500

Content type
application/json
`
[

- {
  - "id": "string",
  - "iso639pt3": "string",
  - "name": "string"
  }

]`

# Organizations

## List

List

##### query Parameters

query | string Query
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/organizations

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "id": "string",
    - "image": "string",
    - "isAutomaticOcrEnabled": true,
    - "name": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "permission": "string",
    - "rootId": "string",
    - "storageCapacity": 0,
    - "updateTime": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## Create

Create

##### Request Body schema: application/json

Body

image | string
name required | string <= 255 characters

### Responses

/v1/organizations

### Request samples

- Payload

Content type
application/json
`
{

- "image": "string",
- "name": "string"

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/organizations/{id}

### Response samples

- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Get by ID

Get by ID

##### path Parameters

id required | string ID

### Responses

/v1/organizations/{id}

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"

}`

## Leave

Leave

##### path Parameters

id required | string ID

### Responses

/v1/organizations/{id}/leave

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Remove member

Remove member

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

userId required | string

### Responses

/v1/organizations/{id}/remove_member

### Request samples

- Payload

Content type
application/json
`
{

- "userId": "string"

}`

### Response samples

- 400
- 404
- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Update name

Update name

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

name required | string <= 255 characters

### Responses

/v1/organizations/{id}/update_name

### Request samples

- Payload

Content type
application/json
`
{

- "name": "string"

}`

### Response samples

- 200
- 400
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "name": "string",
- "permission": "string",
- "updateTime": "string"

}`

# Storage

## Get account usage

Get account usage

### Responses

/v1/storage/get_account_usage

### Response samples

- 200

Content type
application/json
`
{

- "bytes": 0,
- "maxBytes": 0,
- "percentage": 0

}`

## Get file usage

Get file usage

##### query Parameters

id required | string File ID

### Responses

/v1/storage/get_file_usage

### Response samples

- 200

Content type
application/json
`
{

- "bytes": 0,
- "maxBytes": 0,
- "percentage": 0

}`

## Get workspace usage

Get workspace usage

##### query Parameters

id required | string Workspace ID

### Responses

/v1/storage/get_workspace_usage

### Response samples

- 200

Content type
application/json
`
{

- "bytes": 0,
- "maxBytes": 0,
- "percentage": 0

}`

# Users

## List

List

##### query Parameters

query | string Query
organization_id | string Organization ID
group | string Group ID
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/users

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "email": "string",
    - "fullName": "string",
    - "id": "string",
    - "picture": "string",
    - "updateTime": "string",
    - "username": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

# Workspaces

## List

List

##### query Parameters

query | string Query
page | string Page
size | string Size
sort_by | string Sort By
sort_order | string Sort Order

### Responses

/v1/workspaces

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "data":
  [
  - {
    - "createTime": "string",
    - "id": "string",
    - "image": "string",
    - "isAutomaticOcrEnabled": true,
    - "name": "string",
    - "organization":
      {
      - "createTime": "string",
      - "id": "string",
      - "image": "string",
      - "name": "string",
      - "permission": "string",
      - "updateTime": "string"
      },
    - "permission": "string",
    - "rootId": "string",
    - "storageCapacity": 0,
    - "updateTime": "string"
    }
  ],
- "page": 0,
- "size": 0,
- "totalElements": 0,
- "totalPages": 0

}`

## Create

Create

##### Request Body schema: application/json

Body

image | string
name required | string <= 255 characters
organizationId required | string
storageCapacity | integer

### Responses

/v1/workspaces

### Request samples

- Payload

Content type
application/json
`
{

- "image": "string",
- "name": "string",
- "organizationId": "string",
- "storageCapacity": 0

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"

}`

## Delete

Delete

##### path Parameters

id required | string ID

### Responses

/v1/workspaces/{id}

### Response samples

- 500

Content type
application/json
`
{

- "code": "string",
- "message": "string",
- "moreInfo": "string",
- "status": 0,
- "userMessage": "string"

}`

## Get by ID

Get by ID

##### path Parameters

id required | string ID

### Responses

/v1/workspaces/{id}

### Response samples

- 200
- 404
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"

}`

## Update is automatic OCR enabled

Update is automatic OCR enabled

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

isEnabled required | boolean

### Responses

/v1/workspaces/{id}/update_is_automatic_ocr_enabled

### Request samples

- Payload

Content type
application/json
`
{

- "isEnabled": true

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"

}`

## Update name

Update name

##### path Parameters

id required | string ID

##### Request Body schema: application/json

Body

name required | string <= 255 characters

### Responses

/v1/workspaces/{id}/update_name

### Request samples

- Payload

Content type
application/json
`
{

- "name": "string"

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"

}`

## Update storage capacity

Update storage capacity

##### path Parameters

id required | string Id

##### Request Body schema: application/json

Body

storageCapacity required | integer >= 1

### Responses

/v1/workspaces/{id}/update_storage_capacity

### Request samples

- Payload

Content type
application/json
`
{

- "storageCapacity": 1

}`

### Response samples

- 200
- 400
- 500

Content type
application/json
`
{

- "createTime": "string",
- "id": "string",
- "image": "string",
- "isAutomaticOcrEnabled": true,
- "name": "string",
- "organization":
  {
  - "createTime": "string",
  - "id": "string",
  - "image": "string",
  - "name": "string",
  - "permission": "string",
  - "updateTime": "string"
  },
- "permission": "string",
- "rootId": "string",
- "storageCapacity": 0,
- "updateTime": "string"

}`