Page Comparison

The public API is exposed as part of the BusinessGPT Firewall.

API KEY

The API allows sending requests to AI service through HTTP requests.

Each user has a unique API key to be used for authentication to authenticate the API. The API key is viewed on the User Settings page in the dashboard. Need You need to copy it and send in the request.

...

Image Added

Chat service - POST request

Allows to send prompt to the AI and receive response based on some particular content or all company data

...

• APIKey

• Prompt

• PromptScope (Content, Collection, All)

• PromptScopeId (id of the content of the collection, not needed for All)

• AIModel (optional. Default will be as for the user. Available values: GPT3_5, GPT4)

• ChatId (optional) - if : If provided, will add the question will be added to the existing chat with an external chat ID that equals the provided value. If no chat exists, will create a new one will be created.

Output - for HTTP status OK (200):

• PromptId

• Response

In case of error, it will return an error message.

Image RemovedImage Added

Attached is the Postman collection with example requests.

...