Skip to content

Updated 3 hyperlinks in the Readme file #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Prashant-Vandana wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated 3 hyperlinks in the Readme file #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Additionally, this library provides convenient features including a streamlined
To obtain an API Key, login to the [Nightfall dashboard](https://app.nightfall.ai/) and click the section
titled "Manage API Keys".

See our [developer documentation](https://docs.nightfall.ai/docs/entities-and-terms-to-know) for more details about
See our [developer documentation](https://help.nightfall.ai/firewall-for-ai/key-concepts/entities-and-terms-to-know) for more details about
integrating with the Nightfall API.

## Installation ##
Expand Down Expand Up @@ -43,11 +43,11 @@ original files, and then we'll handle the heavy lifting.

The file upload process is implemented as a series of requests to upload the file in chunks. The library
provides a single method that wraps the steps required to upload your file. Please refer to the
[API Reference](https://docs.nightfall.ai/reference) for more details.
[API Reference](https://help.nightfall.ai/firewall-for-ai/nightfall-apis/dlp-apis-firewall-for-ai-platform) for more details.

The file is uploaded synchronously, but as files can be arbitrarily large, the scan itself is conducted asynchronously.
The results from the scan are delivered by webhook; for more information about setting up a webhook server, refer to
[the docs](https://docs.nightfall.ai/docs/creating-a-webhook-server).
[the docs](https://help.nightfall.ai/firewall-for-ai/key-concepts/scanning-files/webhooks-and-asynchronous-notifications/creating-a-webhook-server).

#### Sample Code

Expand Down