Skip to main content

Uniphore Help Center Portal

Fetch Virtual Agent (VA) Details

Returns the VA-NLU details for the specified virtual agents. These details are used to delete the pods that are associated to the VA.

Endpoint

URL: https://uselfserve-<tenant_name>.us.cloud.uniphore.com/cse/virtualAgents/{vrmId}/getVANLUDetailsForDeletePod?catId={catId}

Method: POST

Header Parameter
<Bearer token>
Path Parameter

Parameter Name

Datatype

Description

Required/ Optional

vrmId

Number

Enter 100000 as the default value.

Required

Query Parameter

Parameter Name

Datatype

Description

Required/ Optional

catId

String

Id of the category to which the VA belongs to.

Required

Request Body
[
  "{vitual_agent_name_1}",
  "{vitual_agent_name_2}"
]

The request body should contain a JSON arrary with the names of the virtual agents whose details need to be fetched. Replace {vitual_agent_name_1}, {vitual_agent_name_2}, etc., with the actual virtual agent names.

Example cURL Request
curl -X 'POST' \
  'https://uselfserve-<tenant-name>.us.cloud.uniphore.com/cse/virtualAgents/100000/getVANLUDetailsForDeletePod?catId=<catId>' \
     -H 'accept: */*' \
     -H 'Authorization: Bearer <token>' \
     -H 'Content-Type: application/json' \
     -d '[
           "VA1_en_us"
         ]'
Example Response
{
  "vrmDetailsNLU": [
    {
      "vaName": "VA1_en_us",
      "isLive": "live",
      "langName": "en-US",
      "url": "http://platform-rasa-live-<tenant-name>-1-1-1-en-us.platform:5005",
      "vnmId": 64,
      "vrmId": 1,
      "engId": 2,
      "vlmId": 68,
      "folderPath": "/nfs/rasa/live/<tenant-name>/1/1/1/en-us",
      "replicaCount": 1,
      "serviceName": "platform-rasa-live-<tenant-name>-1-1-1-en-us.platform",
      "tenant": "<tenant-name>",
      "organization": "1",
      "category": "1",
      "language": "en-US",
      "env": "live",
      "containerPort": "5005",
      "servicePort": "5005"
    },
    {
      "vaName": "VA1_en_us",
      "isLive": "test",
      "langName": "en-US",
      "url": "http://platform-rasa-test-<tenant-name>-1-1-1-en.platform:5005",
      "vnmId": 66,
      "vrmId": 2,
      "engId": 2,
      "vlmId": 71,
      "folderPath": "/nfs/rasa/test/<tenant-name>/1/1/1/en",
      "replicaCount": 1,
      "serviceName": "platform-rasa-test-<tenant-name>-1-1-1-en.platform",
      "tenant": "<tenant-name>",
      "organization": "1",
      "category": "1",
      "language": "en-US",
      "env": "test",
      "containerPort": "5005",
      "servicePort": "5005"
    }
  ],
  "errorBody": null
}