Introduction #
You can download the last V6 version with support for the new cloud feature from the official GitHub repository at: https://github.com/IKAJIAN/rtila-releases/releases/tag/v6.0.0
A valid RTILA Studio License Key is required and replaces the former MID and Token for authentication purposes.
Prepare Argument Variables #
Before using the Cloud API you need to prepare your automation project to declare and use a specific type of Variable that is the only type of Variable that is accessible via API queries. These variables are called “Command-line Arguments”. You can rename these commands if you are going to use more than one argument. All declared Arguments Variables will be available via API or via Zapier/Pabbly/Make integrations.
Test authentication credentials #
Authentication #
API endpoint to test user credentials.
https://cloud.rtila.net/meQuery Parameter(s) #
| Field | Type | Description |
|---|---|---|
| key required | String | Your main License key |
Success 200 #
| Field | Type | Description |
|---|---|---|
| email required | String | Email address of the license holder |
| plan_name required | String | Name of the purchased plan |
| activated_machines required | String | Number of the activated machines using same license keys |
403 Forbidden #
| Name | Description |
|---|---|
| message required | “Invalid request. Please try again.” |
500 Internal Server Error #
| Name | Description |
|---|---|
| message required | “An error has occurred. Please try again.” |
Bots #
Bots | Get the UUID of a project #
The endpoint below is used exclusively by the software to upload project data to the cloud and gets the UUID of the uploaded project.
https://cloud.rtila.net/upload-projectQuery Parameter(s) #
| Field | Type | Description |
|---|---|---|
| key required | String | Your main License key |
Request Body #
| Field | Type | Description |
|---|---|---|
| Uuid required | String | UUID of a project |
| data required | String | Project Data |
Success 200 #
| Field | Type | Description |
|---|---|---|
| status required | Boolean | “true” |
| message required | String | “Project uploaded successfully.” |
| Uuid required | String | Universal Unique Identifier of the uploaded project |
403 Forbidden #
| Name | Description |
|---|---|
| message required | “Invalid request. Please try again.” |
500 Internal Server Error #
| Name | Description |
|---|---|
| message required | “An error has occurred. Please try again.” |
Bots | Run an online bot #
https://cloud.rtila.net/queue/:uuidParameter #
| Field | Type | Description |
|---|---|---|
| Uuid required | String | UUID of a project |
Query Parameter(s) #
| Field | Type | Description |
|---|---|---|
| key required | String | Your main License key |
Request Body #
| Field | Type | Description |
|---|---|---|
| variables required | Dictionary | Dictionary with key/value pairs |
Success 200 #
| Field | Type | Description |
|---|---|---|
| status required | Boolean | “true” |
| message required | String | “Project queued successfully.” |
P403 Forbidden #
| Name | Description |
|---|---|
| message required | “Invalid request. Please try again.” |
500 Internal Server Error #
| Name | Description |
|---|---|
| message required | “An error has occurred. Please try again.” |
Results #
Results | Get extracted results #
Once a bot is finished, all its extracted data will be available via this endpoint.
https://cloud.rtila.net/queue/:uuidParameter #
| Field | Type | Description |
|---|---|---|
| Uuid required | String | UUID of a project |
Query Parameter(s) #
| Field | Type | Description |
|---|---|---|
| key required | String | Your main License key |
Success 200 #
| Field | Type | Description |
|---|---|---|
| completedAt required | Date | Completion datetime |
Success 200 (List of objects) #
| Field | Type | Description |
|---|---|---|
| Datasets required | Object | List of dataset results |
P403 Forbidden #
| Name | Description |
|---|---|
| message required | “Invalid request. Please try again.” |
500 Internal Server Error #
| Name | Description |
|---|---|
| message required | “An error has occurred. Please try again.” |
