start converting files to a whiteboard renderable format

post/v1/whiteboard/fileconvert

start converting files to a whiteboard renderable format

post/v1/whiteboard/fileconvert

https://managedservices-prod.rteappbuilder.com/

Request

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
}

Responses

200

400

403

404

500

200

success

400

invalid input or request body

error

TYPE: OBJECT

code

TYPE: INTEGER

---

message

TYPE: STRING

---

403

forbidden if whiteboard isnt setup for your project

error

TYPE: OBJECT

code

TYPE: INTEGER

---

message

TYPE: STRING

---

404

not found if passphrase is invalid

error

TYPE: OBJECT

code

TYPE: INTEGER

---

message

TYPE: STRING

---

500

internal server error

error

TYPE: OBJECT

code

TYPE: INTEGER

---

message

TYPE: STRING

---

200

400

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

403

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

404

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

500

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

POST /v1/whiteboard/fileconvert

Request

Base URL

https://managedservices-prod.rteappbuilder.com

Authorization — header required

Body

{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'

curl -L -X POST 'https://managedservices-prod.rteappbuilder.com/v1/whiteboard/fileconvert' \
-H 'Content-Type: application/json' \
--data-raw '{
  "resource_url": "https://foo.com",
  "passphrase": "42c9af431-d50e-4be7-b0af-0335f7b4x7a4",
  "conversion_type": "static",
  "conversion_scale": 0.3
}'