Article

    help.nightfall.ai / developer-api / welcome-to-developer-apis-documentation.md

    3 min read
    Last updated 3 months ago

    For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

    Welcome to Developer APIs Documentation

    Welcome to the amazing world of the Nightfall Developer APIs (formerly known as Firewall for AI). Here you can find all the information about Nightfall's APIs, and SDKs, and also usage examples of these APIs and SDKs.

    Getting StartedLearn how to create a Nightfall API key, Detectors, Detection rules, and Polices/pages/NeXWlxIEjeijdZ9fDAmE/files/p6smoWXMrlWVrnGdyMd1
    Nightfall APIsNightfall Scan and Workflow APIs enable you to integrate DLP protection programaticallyhttps://help.nightfall.ai/nightfall-firewall-for-ai/nightfall-apis/dlp-apis-firewall-for-ai-platform/files/tRPs2uqO8Y26ZQtuYpji
    SDKsLearn how to leverage the Nightfall Software Development Kits (SDKs)/pages/MaWfV3PsrIJBe7qilmgh/files/CZCVE7sc59a8suyB2Ch5
    Language Specific GuidesLearn how to use Nightfall's APIs/SDKs with specific programming languages./pages/SuQtZOYIjtUwF3EOs2zx/files/gWZtlLo14TJTSmXbBOXh
    Integration TutorialsLearn how to integrate Nightfall into some GenAI apps and datastores./pages/lcPDqZnoUIUvD2sxJLvw/files/ktNPOF4GQEvnJaw35J6i
    Popular Use CasesReview popular scenarios and apply them to your DLP use case./pages/4agObkPH5rmLf9gEswKM/files/Pnik5pmYBhEe305xGhN0
    Detection PlaygroundA code free environment for test driving Firewall for AI.https://playground.nightfall.ai//files/j5jPK8zjTx8Os0hv7f6Z

    Agent Instructions

    This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

    Querying This Documentation

    If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

    Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:

    GET https://help.nightfall.ai/developer-api/welcome-to-developer-apis-documentation.md?ask=<question>&goal=<endgoal>
    

    ask is the immediate question: it should be specific, self-contained, and written in natural language. goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

    The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

    Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.