API docs by Redocly

NVIDIA ACE Agent Plugin Server (4.0.0)

Download OpenAPI specification:Download

Health APIs

Status

Health Check Endpoint

Responses

Response samples

Content type
application/json
null

Get Metrics

Responses

Response samples

Content type
application/json
null

Name

Responses

Response samples

Content type
application/json
null

Get Fulfillment List

Responses

Response samples

Content type
application/json
[
  • {
    }
]

date

Get Date

Get current date from datetime module

Responses

Response samples

Content type
application/json
null

Get Time

Get current time from datetime module

Responses

Response samples

Content type
application/json
null

stock

Get Ticker

Take company name returns ticker symbol used for trading param Args: company_name: company name like Microsoft Returns: Ticker Symbol used for trading like MSFT for microsoft

query Parameters
company_name
required
string (Company Name)

Responses

Response samples

Content type
application/json
"string"

Get Stock Price

get a stock price from yahoo finance api

query Parameters
company_name
required
string (Company Name)

Responses

Response samples

Content type
application/json
0
0

weather

Get Weather

Get weather information for location provided in fulfillment request param: request_data: DM fulfillment request

Request Body schema: application/json
required
UserId
required
string (Userid)
Domain
required
string (Domain)
Intent
required
string (Intent)
Language
required
string (Language)
Query
required
string (Query)
QueryId
required
string (Queryid)
ProcessedQuery
required
string (Processedquery)
SessionId
required
string (Sessionid)
StreamId
required
string (Streamid)
Event
string (Event)
NlpResp
object (Nlpresp)
Slots
object (Slots)
LinkedSlots
object (Linkedslots)
FulfillmentSlots
object (Fulfillmentslots)
Parameters
object (Parameters)
History
object (History)
Memory
object (Memory)

Responses

Request samples

Content type
application/json
{
  • "UserId": "string",
  • "Domain": "string",
  • "Intent": "string",
  • "Language": "string",
  • "Query": "string",
  • "QueryId": "string",
  • "ProcessedQuery": "string",
  • "SessionId": "string",
  • "StreamId": "string",
  • "Event": "string",
  • "NlpResp": { },
  • "Slots": { },
  • "LinkedSlots": { },
  • "FulfillmentSlots": { },
  • "Parameters": { },
  • "History": { },
  • "Memory": { }
}

Response samples

Content type
application/json
{
  • "UserResponse": { },
  • "Status": "",
  • "FulfillmentSlots": { },
  • "CustomData": { },
  • "InvalidSlots": [
    ],
  • "Slots": { },
  • "StatusDetails": "",
  • "Memory": { }
}

Get Weather Condition

Return weather condition for given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
"string"

Get Temperature

Return temperature for given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
0
0

Is Sunny

Check if weather is sunny at given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
true

Is Cloudy

check if weather is cloudy at given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
true

Get Rain Precip

return rain precip for given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
"string"

Is Raining

check if it is raining at given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
true

Is Snowing

check if it is snowing at given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
true

Get Humidity

return humidity for given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
"string"

Get Windspeed

return wind speed for given location

query Parameters
location
required
string (Location)

Responses

Response samples

Content type
application/json
"string"

rag

Chat

This endpoint can be used to provide response to query driven user request.

Request Body schema: application/json
required
Query
string (Query)
Default: ""

The user query which needs to be processed.

UserId
required
string (Userid)

Mandatory unique identifier to recognize which user is interacting with the Chat Engine.

Responses

Request samples

Content type
application/json
{
  • "Query": "",
  • "UserId": "string"
}

Response samples

Content type
application/json
null

Event

This endpoint can be used to provide response to an event driven user request.

Request Body schema: application/json
required
EventType
string (Eventtype)
Default: ""

The event name which needs to be processed.

UserId
required
string (Userid)

Mandatory unique identifier to recognize which user is interacting with the Chat Engine.

Responses

Request samples

Content type
application/json
{
  • "EventType": "",
  • "UserId": "string"
}

Response samples

Content type
application/json
Example
{
  • "UserId": "",
  • "Events": [ ],
  • "Response": {
    }
}