post/v1/whiteboard/fileconvert
https://managedservices-prod.rteappbuilder.com/
HEADER
AuthorizationREQUIRED
TYPE: STRING
JWT token as auth header. Format "Bearer <xxxxx.yyyyy.zzzzz>" xxxxx.yyyyy.zzzzz is the JWT token
REQUEST BODY
request a file conversion from agora api
resource_url
TYPE: STRING
passphrase
TYPE: STRING
conversion_type
TYPE: STRING
[static, dynamic]
conversion_scale
TYPE: NUMBER
[0.1 - 3]
SAMPLE REQUEST
{
"resource_url": "https://foo.com",
"passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
"conversion_type": "static",
"conversion_scale": 0.3
}
success
invalid input or request body
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
forbidden if whiteboard isnt setup for your project
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
not found if passphrase is invalid
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
internal server error
error
TYPE: OBJECT
code
TYPE: INTEGER
message
TYPE: STRING
SAMPLE RESPONSE
{
"error": {
"code": 611,
"message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
}
}
SAMPLE RESPONSE
{
"error": {
"code": 611,
"message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
}
}
SAMPLE RESPONSE
{
"error": {
"code": 611,
"message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
}
}
SAMPLE RESPONSE
{
"error": {
"code": 611,
"message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
}
}
Loading...