...
| Table of Contents | ||
|---|---|---|
|
Getting API KEY
The API allows sending requests to AI service through HTTP requests.
Each user has a unique API key to authenticate the API. The API key is viewed on the User Settings page in the dashboard. You need to copy it and send in the request.
...
Chat service - POST request
POST: https://[firewall API address]/firewallApi/v1/chat
...
In case of an error, it will return an error message.
...
How do you find the ID of the collection or content item for the “PromptScopeId” parameter?
To find the ID triple-click the line to get some system info:
...
For a document it is the contentID as in the image below
...
Upload service - POST request
POST: https://[firewall API address]/firewallApi/v1/upload
...
APIKey
FileName
FileContent - binary
ContentSourceName (optional)- The name of the client using the API (for example, File loader)
ContentSourceIP (optional)- The IP of the client using the API (for example the host of the File loader)
AllowedGroups (optional)
AllowedEmails (optional)
Action (string, optional, default: "Add")
The action to be performed on the file. Possible values include:Add: Upload a new file (default action).UpdatePermissions: Modify permissions for an existing file.Rename: Change the name of an existing file.Delete: Remove an existing file.
ContentId (string, required for
UpdatePermissions,Rename, orDelete)
Output - for HTTP status OK (200):
...
In case of an error, it will return an error message.
...
Get classifications service - GET request
GET: https://[firewall API address]/firewallApi/v1/getClassifications
...
In case of an error, it will return an error message.
...
Healthcheck service - GET request
GET: https://[firewall API address]/firewallApi/v1/alive
Sample URL for BGD10 environment:https://bgd10-firewall.agatdemo.com/firewallApi/v1/alive
...
Postman Samples for all APIs
Attached is the Postman collection with example requests.
...