API docs by Redocly

Zextras Carbonio Workstream Collaboration API (1.6.5)

Download OpenAPI specification:

Zextras Carbonio Workstream Collaboration HTTP APIs definition.

License

Returns wsc license info

Responses

Response samples

Content type
application/json
{
  • "licensed": true
}

Rooms

Retrieves a list of every room the user has access to

query Parameters
extraFields
Array of strings (RoomExtraField)
Items Enum: "members" "settings"

Rooms extra fields

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert a room of the specified type

Inserts a room of the specified type. The user performing the request will be included in the final members list if not specified. If the room is a one-to-one, only a single member can be specified and name and description are replaced with an empty string. If the room is not a one-to-one, there must be at least two members specified.

Request Body schema: application/json
required

room to insert

Array of objects (Member)

list of users to add to the room

name
string [ 1 .. 128 ] characters

room name

description
string [ 0 .. 256 ] characters

room description

type
required
string (RoomType)
Enum: "group" "one_to_one" "temporary"

Managed room types

Responses

Request samples

Content type
application/json
{
  • "members": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "group"
}

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "group",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meetingId": "bba231d0-d474-4cf9-bb49-b12d0cb2a3ed",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "pictureUpdatedAt": "2019-08-24T14:15:22Z",
  • "userSettings": {
    }
}

Retrieves the requested room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "group",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meetingId": "bba231d0-d474-4cf9-bb49-b12d0cb2a3ed",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "pictureUpdatedAt": "2019-08-24T14:15:22Z",
  • "userSettings": {
    }
}

Updates a room information

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

room fields to update

name
string [ 1 .. 128 ] characters

room name

description
string [ 0 .. 256 ] characters

room description

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "members": [
    ],
  • "name": "string",
  • "description": "string",
  • "type": "group",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meetingId": "bba231d0-d474-4cf9-bb49-b12d0cb2a3ed",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "pictureUpdatedAt": "2019-08-24T14:15:22Z",
  • "userSettings": {
    }
}

Deletes the specified room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Retrieves the room picture

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Uploads and sets a new room picture

path Parameters
roomId
required
string <uuid>

room identifier

header Parameters
fileName
required
string

file name encoded to unicode

mimeType
required
string

content type

Content-Length
required
integer <int64>

content length

Request Body schema: application/octet-stream
required

image to set

string <binary>

Responses

Delete the room picture

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Mutes notification for the specified room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Unmutes notification for the specified room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Clears all messages for the specified room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Response samples

Content type
application/json
{
  • "clearedAt": "2019-08-24T14:15:22Z"
}

Add or invite the specified users to the room

Add the specified users to the room. This can only be performed by an owner of the given room

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

members to add or invite

Array
userId
required
string <uuid>

user identifier

owner
required
boolean
Default: false

indicates whether it is the owner

external
boolean
Default: false

indicates whether it is an external user

historyCleared
required
boolean
Default: false

indicates whether it can see previous messages, after it has been added to the room

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update existing room owners

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

members to update

Array
userId
required
string <uuid>

user identifier

owner
boolean
Default: false

indicates whether it is the owner

external
boolean
Default: false

indicates whether it is an external user

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves the meeting associated with the requested room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Retrieves paged list of metadata of every attachment uploaded to the room and the filter for the next page

path Parameters
roomId
required
string <uuid>

room identifier

query Parameters
itemsNumber
integer
Default: 10

number of page items

filter
string

pagination filter

Responses

Response samples

Content type
application/json
{
  • "filter": "string",
  • "attachments": [
    ]
}

Insert an attachment

path Parameters
roomId
required
string <uuid>

room identifier

header Parameters
fileName
required
string

file name encoded to unicode

mimeType
required
string

content type

description
string

description encoded to unicode

messageId
string

description

replyId
string

identifier of the message being replied to

area
string

attachment's area

Content-Length
required
integer <int64>

content length

Request Body schema: application/octet-stream
required

file stream

string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Insert an attachment with multipart/form-data

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: multipart/form-data
required

Attachment upload form data

file
required
string <binary>

file to upload

description
string

description encoded to unicode

messageId
string

identifier of the message

replyId
string

identifier of the message being replied to

area
string

area of the attachment

contentLength
integer <int64>

content length

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Message forwarding

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

Messages forwarding request

Array
originalMessage
required
string

XML message to forward

originalMessageSentAt
string <date-time>

date and time the original message was sent

description
string

description of the forwarded message

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Members

Retrieves every member to the given room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add or invite the specified users to the room

Add the specified users to the room. This can only be performed by an owner of the given room

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

members to add or invite

Array
userId
required
string <uuid>

user identifier

owner
required
boolean
Default: false

indicates whether it is the owner

external
boolean
Default: false

indicates whether it is an external user

historyCleared
required
boolean
Default: false

indicates whether it can see previous messages, after it has been added to the room

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Removes a member from the room

Removes a member from the specified room. If the specified user is different from the requester, this action is considered as a kick

path Parameters
roomId
required
string <uuid>

room identifier

userId
required
string <uuid>

user identifier

Responses

Promotes a member to owner

path Parameters
roomId
required
string <uuid>

room identifier

userId
required
string <uuid>

user identifier

Responses

Demotes a member from owner to normal member

path Parameters
roomId
required
string <uuid>

room identifier

userId
required
string <uuid>

user identifier

Responses

Update existing room owners

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

members to update

Array
userId
required
string <uuid>

user identifier

owner
boolean
Default: false

indicates whether it is the owner

external
boolean
Default: false

indicates whether it is an external user

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Users

Retrieves users

query Parameters
userIds
required
Array of strings <uuid> <= 10 items [ items <uuid > ]

List of ids (max 10) of the users to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve current user capabilities

Responses

Response samples

Content type
application/json
{
  • "canSeeMessageReads": true,
  • "canSeeUsersPresence": true,
  • "canVideoCall": true,
  • "canVideoCallRecord": true,
  • "canUseVirtualBackground": true,
  • "editMessageTimeLimitInMinutes": 0,
  • "deleteMessageTimeLimitInMinutes": 0,
  • "maxGroupMembers": 0,
  • "maxRoomImageSizeInKb": 0,
  • "maxUserImageSizeInKb": 0
}

Retrieves a user

path Parameters
userId
required
string <uuid>

user identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "name": "string",
  • "type": "internal",
  • "statusMessage": "string"
}

Guests

Creates a guest user

Request Body schema: application/json
required

name of the guest user to create

name
string

name of the guest user

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "zmToken": "string",
  • "zxToken": "string",
  • "id": "string"
}

Attachments

Retrieves paged list of metadata of every attachment uploaded to the room and the filter for the next page

path Parameters
roomId
required
string <uuid>

room identifier

query Parameters
itemsNumber
integer
Default: 10

number of page items

filter
string

pagination filter

Responses

Response samples

Content type
application/json
{
  • "filter": "string",
  • "attachments": [
    ]
}

Insert an attachment

path Parameters
roomId
required
string <uuid>

room identifier

header Parameters
fileName
required
string

file name encoded to unicode

mimeType
required
string

content type

description
string

description encoded to unicode

messageId
string

description

replyId
string

identifier of the message being replied to

area
string

attachment's area

Content-Length
required
integer <int64>

content length

Request Body schema: application/octet-stream
required

file stream

string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Insert an attachment with multipart/form-data

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: multipart/form-data
required

Attachment upload form data

file
required
string <binary>

file to upload

description
string

description encoded to unicode

messageId
string

identifier of the message

replyId
string

identifier of the message being replied to

area
string

area of the attachment

contentLength
integer <int64>

content length

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Message forwarding

path Parameters
roomId
required
string <uuid>

room identifier

Request Body schema: application/json
required

Messages forwarding request

Array
originalMessage
required
string

XML message to forward

originalMessageSentAt
string <date-time>

date and time the original message was sent

description
string

description of the forwarded message

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Deletes an uploaded attachment

path Parameters
fileId
required
string <uuid>

file identifier

Responses

Retrieves info related to an uploaded attachment

path Parameters
fileId
required
string <uuid>

file identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "size": 0,
  • "mimeType": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "area": "string"
}

Retrieves an uploaded attachment

path Parameters
fileId
required
string <uuid>

file identifier

Responses

Health

Returns the general service status

Responses

Response samples

Content type
application/json
{
  • "isLive": true,
  • "status": "ok",
  • "dependencies": [
    ]
}

Returns 204 if the service is alive

Responses

Returns 204 if the service is ready to receive requests

Responses

Authentication

Fetches the authenticated token

Responses

Response samples

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

Meetings

Retrieves the meeting associated with the requested room

path Parameters
roomId
required
string <uuid>

room identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Retrieves public data of the meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Response samples

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

Retrieves a list of every meeting the user has access to

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new meeting

Request Body schema: application/json
required

Data to create a new meeting

name
required
string
roomId
string <uuid>
meetingType
required
string (MeetingType)
Enum: "permanent" "scheduled"

Defines the type of meeting, if permanent it will never be automatically deleted, if scheduled it will be removed after the expiration is passed

expiration
string <date-time>

This field is only used for scheduled meetings to indicate when the meeting will no more be necessary

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "meetingType": "permanent",
  • "expiration": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Retrieves the requested meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Deletes the requested meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Starts the current meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Stops the current meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
  • "active": true,
  • "participants": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "meetingType": "permanent",
  • "recStartedAt": "2019-08-24T14:15:22Z",
  • "recUserId": "afe41963-8cfa-48e9-b5e3-94c589db1681"
}

Adds the current user to the specified meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request containing its streams settings to join a meeting

audioStreamEnabled
required
boolean
Default: false

indicates the audio stream status to join the meeting

videoStreamEnabled
required
boolean
Default: false

indicates the video stream status to join the meeting

Responses

Request samples

Content type
application/json
{
  • "audioStreamEnabled": false,
  • "videoStreamEnabled": false
}

Response samples

Content type
application/json
{
  • "status": "ACCEPTED"
}

Remove the current user to the specified meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Retrieve the list of people in queue for the meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Updates the status of a queued user

path Parameters
meetingId
required
string <uuid>

meeting identifier

userId
required
string <uuid>

user identifier

Request Body schema: application/json
required

request to approve or reject a user inside a meeting

status
string (QueueUpdateStatus)
Enum: "ACCEPTED" "REJECTED"

Responses

Request samples

Content type
application/json
{
  • "status": "ACCEPTED"
}

Update media stream status for the current session

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to update a media stream status

type
required
string
Enum: "video" "screen"

indicates the media stream type

enabled
required
boolean

indicates the status to change the media stream to

sdp
string

indicates the descriptor of the session

Responses

Request samples

Content type
application/json
{
  • "type": "video",
  • "enabled": true,
  • "sdp": "string"
}

Complete WebRTC negotiation for media streams for the current session

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to send a rtc session description related to media stream for WebRTC negotiation

sdp
required
string

indicates the descriptor of the session

Responses

Request samples

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

Update subscriptions of the current session to the desired media streams

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to update subscriptions to the desired media stream

required
Array of objects (MediaStream)

indicates the media streams which user wants to subscribe to

required
Array of objects (MediaStream)

indicates the media streams which user wants to unsubscribe to

Responses

Request samples

Content type
application/json
{
  • "subscribe": [
    ],
  • "unsubscribe": [
    ]
}

Update audio stream status for a user, a moderator can disable audio for another user

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to update a meeting stream status

enabled
required
boolean

indicates the status to change the audio stream to

userToModerate
string

optional user to mute if i'm a moderator, only works if enabled is false

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "userToModerate": "string"
}

Start WebRTC negotiation for audio stream for the current session

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to send a rtc session description related to media stream for WebRTC negotiation

sdp
required
string

indicates the descriptor of the session

Responses

Request samples

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

Start recording on the specified meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
optional

user request to stop recording on a specific meeting

name
string [ 1 .. 128 ] characters

recording name

folderId
string

folder id where the recording will be saved

Responses

Request samples

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

Stop recording on the specified meeting

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
optional

user request to stop recording on a specific meeting

name
string [ 1 .. 128 ] characters

recording name

folderId
string

folder id where the recording will be saved

Responses

Request samples

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

Update hand status for a user during a meeting, a moderator can lower down the hand for another user

path Parameters
meetingId
required
string <uuid>

meeting identifier

Request Body schema: application/json
required

user request to update hand status during a meeting

raised
required
boolean

indicates the status to change the hand to

userToModerate
string

optionally lower the user's hand if I'm a moderator, only works if raised is false

Responses

Request samples

Content type
application/json
{
  • "raised": true,
  • "userToModerate": "string"
}

Public

Preview

Get image preview

Creates and returns a preview of the image fetched by id with the given size, quality and format

  • fileId: UUID of the image
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • crop: True will crop the picture starting from the borders. This option will lose information, leaving it False will scale and have borders to fill the requested size.
path Parameters
fileId
required
string <uuid>

file identifier

area
required
string (Area)
query Parameters
quality
string (ImageQualityEnum)
Enum: "Lowest" "Low" "Medium" "High" "Highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Enum: "Jpeg" "Png" "Gif"

Class representing all the image type accepted values

crop
boolean (Crop)
Default: false

Responses

Get image thumbnail

Creates and returns a preview of the image fetched by id with the given size, quality and format

  • fileId: UUID of the image
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • shape: Rounded and Rectangular are currently supported.
path Parameters
fileId
required
string <uuid>

file identifier

area
required
string (Area)
query Parameters
quality
string (ImageQualityEnum)
Enum: "Lowest" "Low" "Medium" "High" "Highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Enum: "Jpeg" "Png" "Gif"

Class representing all the image type accepted values

shape
string (ImageShapeEnum)
Default: "Rectangular"
Enum: "Rounded" "Rectangular"

Class representing all the image shape accepted values

Responses

Get pdf preview

Creates and returns a preview of the pdf fetched by id, the pdf file will contain the first and last page given. With default values it will return a pdf with all the pages.

  • fileId: UUID of the pdf
  • first_page: integer value of first page to preview (n>=1)
  • last_page: integer value of last page to preview (0 = last of the original pdf)
path Parameters
fileId
required
string <uuid>

file identifier

query Parameters
firstPage
integer (FirstPage)
lastPage
integer (LastPage)

Responses

Get pdf thumbnail

Creates and returns a preview of the pdf fetched by id with the given size, quality and format

  • fileId: UUID of the pdf
  • quality: quality of the output image (the higher you go the slower the process)
  • output_format: format of the output image
  • area: width of the output image (>=0) x height of the output image (>=0), width x height => 100x200. The first is width, the latter height, the order is important!
  • shape: Rounded and Rectangular are currently supported.
path Parameters
fileId
required
string <uuid>

file identifier

area
required
string (Area)
query Parameters
quality
string (ImageQualityEnum)
Enum: "Lowest" "Low" "Medium" "High" "Highest"

Class representing all the image quality accepted values

output_format
string (ImageTypeEnum)
Enum: "Jpeg" "Png" "Gif"

Class representing all the image type accepted values

shape
string (ImageShapeEnum)
Default: "Rectangular"
Enum: "Rounded" "Rectangular"

Class representing all the image shape accepted values

Responses