CRBNai API
    CRBNai API
    • README
    • Authentication
    • Guides
      • Creating a Knowledge Bot
    • API Keys
      • Get all API Keys
        GET
      • Create API Key
        POST
      • Delete API Key
        DELETE
    • Chats
      • Messages
        • Get Chat Messages
        • Post Chat Message
      • Recipes
        • Get All Chat Recipes
      • Get All Chats
        GET
      • Create Chat
        POST
    • Documents
      • Delete Document
        DELETE
      • Download Document
        GET
      • Update Document
        PUT
    • Knowledge Bots
      • Documents
        • Add Document to Knowledge Bot
        • Prepare Document Upload
      • Chats
        • Chat Messages
          • Get Messages of a Knowledge Bot chat
          • Post a message to a Knowlege Bot chat
        • Get all Knowledge Bot chats
        • Create Knowledge Bot chat
      • Chats - deprecated
        • Chat with a Knowledge Bot
      • Create Knowledge Bot
        POST
      • Get All Knowledge Bots
        GET
      • Get Knowledge Bot by ID
        GET
      • Delete Knowledge Bot by ID
        DELETE
      • Update Knowledge Bot by ID
        PUT

    Authentication

    To interact with the CBRN AI API, you'll need an API key linked to your CBRN AI user account. Follow the steps outlined below to generate and use an API key.

    How to Generate an API Key#

    1.
    Navigate to your profile located at the top-right corner of the CRBN AI web interface.
    2.
    Find the section labelled 'API keys' and proceed to add a new API key.
    3.
    Upon creation of a new key, a string will be generated. It is imperative that you copy and save this API key in a secure location as it will only be visible immediately after creation.
    4.
    With your newly generated API key, you can interact with the API as demonstrated in the upcoming sections.
    💡
    For security purposes, your API key is stored in a hashed form on our servers.

    How to Use the API#

    Your API key will be utilized as a Bearer token in the 'Authorization' header of the API call.

    Example#

    A typical API key would appear in the following format: apikeyv1_randomvalues....
    In order to use the API key, insert it into your API call's 'Authorization' header in the following way:
    Authorization: Bearer your_api_key
    Replace your_api_key with your actual API key. This tells the system that you have rights to access the API and perform the specified action.
    Modified at 2023-07-26 17:25:44
    Previous
    README
    Next
    Creating a Knowledge Bot
    Built with