<POST> Chat API
The table below provides a comprehensive breakdown of all the fields included in the API response. It describes each field's purpose, type, and possible values to help you understand how to interpret the API's output effectively.
Field | Type | Description |
---|---|---|
api_status_code | integer | HTTP status code of the API response. Possible values: 200 (Success), 401 (Access Denied), 412 (Precondition Failed), 500 (Internal Server Error). |
api_status_message | string | Message indicating the status of the API call (e.g., "Successful", "LLM Connectivity Issue", "Internal Server Error", "Access Denied"). |
app_prompt | string | The user's application-specific prompt. |
app_prompt_context | string | Context provided alongside the user's prompt. This field is currently an empty string. |
input | dictionary | Details about the input, including: |
| |
|
| |
|
| |
|
| |
|
output | dictionary | Details about the output, including: |
| |
|
| |
|
| |
|
| |
|
metadata | dictionary | Metadata about the API call, including: |
| |
|
| |
|
| |
|
| |
|
| |
|
redacted_prompt | string | Sanitized or redacted version of the user prompt if PII Redaction is enabled, or an empty string otherwise. |
siem | dictionary | Security Information and Event Management (SIEM) details, including: |
| |
|
| |
|
| |
|
| |
|
violation_exist | boolean | Indicates if any policy violations occurred (true or false). |
violation_on | string | Indicates whether the policy violation occurred due to the user's prompt (input) or the LLM response(output). |
This below Gist provides a detailed example of how to connect to the Chat API, including how to structure the request, handle the response, and customize the API call based on your specific needs.
To get started with integrating the Chat API, you can refer to the following GitHub Gist for a step-by-step guide and example code: