API docs by Redocly

Chat Engine Server API (4.0.0)

Download OpenAPI specification:Download

NVIDIA ACE Agent Chat Engine Server API

Health APIs

APIs for checking and monitoring Server Health Status.

Is Ready

Check status of the bots and returns the details of available bots

query Parameters
BotName
string (Botname) <= 4096 characters

Responses

Response samples

Content type
application/json
Example
[ ]

Get Metrics

Responses

Response samples

Content type
application/json
null

Health Check

Perform a Health Check

Returns 200 when service is up. This does not check the health of downstream services.

Responses

Response samples

Content type
application/json
null

Core APIs

APIs for sending user requests with a valid query or event.

Chat

This endpoint can be used to provide response to query driven user request for a specific bot, using defined NLU models and plugin modules. The response formation methodology is picked from the bot configurations and rules defined.

Request Body schema: application/json
required
Botname (string) or Botname (null) (Botname)

The Bot Name which needs to be accessed. This field is mandatory if multiple bots are deployed within Chat Engine. It's value should match the 'bot: ' field defined in the bot config file.

Query (string) or Query (null) (Query)
Default: ""

The user query which needs to be processed.

UserId
required
string (Userid) <= 4096 characters

Mandatory unique identifier to recognize which user is interacting with the chat engine.

Sourcelanguage (string) or Sourcelanguage (null) (Sourcelanguage)

Language of the user query. If language of user query does not match language of the bot, then chat engine tries to call machine translator model (currently not supported) to convert the query to bot language.

Targetlanguage (string) or Targetlanguage (null) (Targetlanguage)

Expected Langauge of Chat Engine Response text. If language of response text does not match expected output language, then chat engine tries to call machine translator model (currently not supported) to do the conversion.

Usercontext (object) or Usercontext (null) (Usercontext)

Any runtime custom parameters needed for dialog flow. tied to this user id. This is populated as part of the request JSON of all fulfillment endpoints as well under context.

Metadata (object) or Metadata (null) (Metadata)
Default: {}

Any chat specific metadata needed for dialog flow.

Responses

Request samples

Content type
application/json
{
  • "BotName": "string",
  • "Query": "",
  • "UserId": "string",
  • "SourceLanguage": "string",
  • "TargetLanguage": "string",
  • "UserContext": { },
  • "Metadata": { }
}

Response samples

Content type
application/json
null

Event

This endpoint can be used to provide response to a event driven user request for a specific bot, using defined NLU models and plugin modules. The response formation methodology is picked from the bot configurations and rules defined.

Request Body schema: application/json
required
Botname (string) or Botname (null) (Botname)

The Bot Name which needs to be accessed. This field is mandatory if multiple bots are deployed within Chat Engine. It's value should match the 'bot: ' field defined in the bot config file.

EventType
string (Eventtype) <= 4096 characters
Default: ""

The event name which needs to be processed.

UserId
required
string (Userid) <= 4096 characters

Mandatory unique identifier to recognize which user is interacting with the chat engine.

Metadata (object) or Metadata (null) (Metadata)
Default: {}

Any event specific metadata needed for dialog flow.

Usercontext (object) or Usercontext (null) (Usercontext)

Any runtime custom parameters needed for dialog flow, tied to this user id. This is populated as part of the request JSON of all fulfillment endpoints as well under context.

Responses

Request samples

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

Response samples

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

User Context APIs

APIs for configuring the user parameters at runtime.

Update User Context

Updates the context of the user at runtime.

query Parameters
UserId
required
string (Userid) <= 4096 characters
Request Body schema: application/json
required
object (Context)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "StatusMessage": "string"
}

Set User Context

Sets the context of the user at runtime. It overwrites any existing context.

Request Body schema: application/json
required
UserId
string (Userid) <= 4096 characters

Unique identifier to recognize which user is interacting with the chat engine.

Context
object (Context)
Default: {}

The key value pairs which needs to be updated in the context of the provided user memory.

required
object (Chathistory) <= 256 properties

The chat history of the provided user id bot wise.

EventHistory
required
object (Eventhistory)

The event history of the provided user id bot wise.

Responses

Request samples

Content type
application/json
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

Response samples

Content type
application/json
{
  • "StatusMessage": "string"
}

Get User Context

Returns the context for a specified user ids.

query Parameters
UserId
required
string (Userid) <= 4096 characters

Responses

Response samples

Content type
application/json
Example
{
  • "UserId": "string",
  • "Context": { },
  • "ChatHistory": {
    },
  • "EventHistory": { }
}

Delete User Context

Deletes the context of the user at runtime.

query Parameters
UserId
required
string (Userid) <= 4096 characters

Responses

Response samples

Content type
application/json
{
  • "StatusMessage": "string"
}

Bot APIs

APIs for controlling bot behaviour at runtime.

Reload Bot

Reloads all the deployed bots or a selected bot if a bot name is provided

query Parameters
BotName
string (Botname) <= 4096 characters
BotVersion
string (Botversion) <= 4096 characters
Default: "1"

Responses

Response samples

Content type
application/json
{
  • "StatusMessage": "string"
}