Voltaserve API (1.0.0)

Download OpenAPI specification:Download

Files

Upload

query Parameters

workspace_id required	string Workspace ID
parent_id	string Parent ID

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Get by ID

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

ids

required

Array of strings

Responses

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

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

200
404
500

Content type

application/json

["string"
]

Get children count

path Parameters

id

required

string

ID

Responses

Response samples

200
404
500

Content type

application/json

0

0

Get path

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

200
404
500

Content type

application/json

0

0

Get user permissions

path Parameters

id

required

string

ID

Responses

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

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

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

ids

required

Array of strings

Responses

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

path Parameters

id

required

string

ID

query Parameters

access_token

required

string

Access Token

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Download original

path Parameters

id

required

string

ID

query Parameters

access_token

required

string

Access Token

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Download preview

path Parameters

id

required

string

ID

query Parameters

access_token

required

string

Access Token

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Rename

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

name

required

string <= 255 characters

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

groupId required	string
ids required	Array of strings

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

id

required

string

Responses

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

Request Body schema: application/json

Body

ids

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"ids": ["string"
]
}

Response samples

200
500

Content type

application/json

["string"
]

Batch get

Request Body schema: application/json

Body

ids

required

Array of strings

Responses

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

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

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

Request Body schema: application/json

Body

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

Responses

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

path Parameters

id

required

string

ID

Responses

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

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

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

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

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

query Parameters

path

required

string

Path

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

ids required	Array of strings
userId required	string

Responses

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

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

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

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

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

Request Body schema: application/json

Body

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

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Get by ID

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Remove member

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

userId

required

string

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

name

required

string <= 255 characters

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

emails required	Array of strings
organizationId required	string

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Accept

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Delete

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Resend

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Get incoming

query Parameters

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

Responses

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

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

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

Responses

Response samples

200

Content type

application/json

[{"body": null,
"type": "string"
}
]

OCRLanguages

List

query Parameters

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

Responses

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

Responses

Response samples

200
404
500

Content type

application/json

[{"id": "string",
"iso639pt3": "string",
"name": "string"
}
]

Organizations

List

query Parameters

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

Responses

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

Request Body schema: application/json

Body

image	string
name required	string <= 255 characters

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Get by ID

path Parameters

id

required

string

ID

Responses

Response samples

200
404
500

Content type

application/json

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

Leave

path Parameters

id

required

string

ID

Responses

Response samples

400
404
500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Remove member

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

userId

required

string

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

name

required

string <= 255 characters

Responses

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

Responses

Response samples

200

Content type

application/json

{"bytes": 0,
"maxBytes": 0,
"percentage": 0
}

Get file usage

query Parameters

id

required

string

File ID

Responses

Response samples

200

Content type

application/json

{"bytes": 0,
"maxBytes": 0,
"percentage": 0
}

Get workspace usage

query Parameters

id

required

string

Workspace ID

Responses

Response samples

200

Content type

application/json

{"bytes": 0,
"maxBytes": 0,
"percentage": 0
}

Users

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

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

query Parameters

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

Responses

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

Request Body schema: application/json

Body

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

Responses

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

path Parameters

id

required

string

ID

Responses

Response samples

500

Content type

application/json

{"code": "string",
"message": "string",
"moreInfo": "string",
"status": 0,
"userMessage": "string"
}

Get by ID

path Parameters

id

required

string

ID

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

isEnabled

required

boolean

Responses

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

path Parameters

id

required

string

ID

Request Body schema: application/json

Body

name

required

string <= 255 characters

Responses

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

path Parameters

id

required

string

Id

Request Body schema: application/json

Body

storageCapacity

required

integer >= 1

Responses

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"
}