Real-Time Assist Management APIs

Real-Time Assist (RTA) Management APIs

This guide describes how to use the Real-Time Assist Management APIs.

The RTA describes the assistance you want for the conversation. The RTA takes input as an object with name and description.

Create RTA

To create an RTA, make the following API call to the endpoint below:

POST https://api.symbl.ai/v1/manage/rta

{
"name": "My Custom RTA",
"description": "This is my real-time assistant."
}

Sample Response: A new RTA is created along with a unique id identifier

Response
{
    "id": "5707126590144512",
    "name": "My Custom RTA",
    "description": "This is my real-time assistant.",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T07:22:49.493Z"
}

Get RTA

You can get all RTAs associated to your account and a specific RTD by their ID.

Here is the request to get a single RTA by sending the ID:

GET https://api.symbl.ai/v1/manage/rta/{rtaID}

Sample Response

{
    "id": "5707126590144512",
    "name": "My Custom RTA",
    "description": "This is my real-time assistant.",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T07:22:49.493Z"
}

Here is the request to get all RTAs associated to your account:

GET https://api.symbl.ai/v1/manage/rta

Sample Response

[
  {
    "id": "5707126590144512",
    "name": "My Custom RTA 1",
    "description": "This is my real-time assistant 1.",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T07:22:49.493Z"
 },
 {
    "id": "5707126590144777",
    "name": "My Custom RTA 2",
    "description": "This is my real-time assistant 2.",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T07:22:49.493Z"
 } 
]

Update RTA

Updating an RTA can be done using PUT and PATCH operations by providing the RTA ID. You can replace, update, or remove individual entities, without updating the rest of the RTA.

Here is the PUT API request to update a criteria:

PUT https://api.symbl.ai/v1/manage/rta/{rtaID}

{
    "name": "My Updated RTA",
    "description": "This is my updated real-time assistant."
}

Sample Response

{
    "id": "5707126590144512",
    "name": "My Updated RTA",
    "description": "This is my updated real-time assistant.",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T09:38:05.271Z"
}

Here is the PATCH API request to update a criteria:

PATCH https://api.symbl.ai/v1/manage/rta/{rtaID}

[
	{
    "op": "replace",
    "path": "/name",
	  "value": "Patched RTA Name"
	},
  {
    "op": "replace",
    "path": "/description",
		"value": "Patched RTA Description"
	}
]

Sample Response

{
    "id": "5753169008656384",
    "name": "Patched RTA Name",
    "description": "Patched RTA Description",
    "createdOn": "2024-08-09T07:22:49.493Z",
    "updatedOn": "2024-08-09T09:44:58.556Z"
}

Delete RTA

Here is the PATCH API request to update a criteria:

DELETE https://api.symbl.ai/v1/manage/rta/{rtaID}

Sample Response

//No response body

Response code (success) is 204

Updated 4 months ago