ReadMe template: Retrieving information

By using this template, you can seamlessly connect to your ReadMe account to retrieve documentation content and present it in your AI Agent when customers ask for support articles or technical help. The template is prefilled with essential information, but you’ll need to fill out a few specific details to connect to your ReadMe project.

📘

This template is triggered by the question "search for". AI Agent users need to type this to trigger the template.

1. Access the template

In your AI Agent in Pulse, navigate to Actions. Select the ReadMe template.
This template comes with prefilled settings to retrieve content such as API docs, guides, or changelogs directly from your ReadMe project.

2. Fill in the required fields

• Base URL: The Base URL is already filled in for you.

• Authentication: Add the API key from ReadMe in the Username field. Keep the Password field empty.

  Creating an API key in ReadMe:

  • Click Configuration
  • Click API Keys
  • Generate your first API key! You can do this by clicking the big blue button in the top right corner and following the steps in the pop-up modal:

  

  
  

• Health Check URL and Instruction:

  • Health Check URL: Define a health check URL to monitor the status of the external server. This URL checks if the server is online.
    The Health Check URL is similar to the BaseURL and can be constructed by appending the health check endpoint to your base URL. Example of a Health Check URL:

  https://example.com/api/v1/health_check
  

  • Health Check Instruction: Add an instruction for the AI Agent to follow if the server is not online. For example, you can instruct the AI Agent to respond with: "Sorry, something went wrong on our end. Can I assist you with anything else?"

3. Optional: Update the Schema

The template already has a filled-in schema, so you can use it right away. If you want, you can change the schema to fit other purposes.

4. Validating your Action

After filling in the required details and schema:

• Validate: Click Validate to check for any errors in your schema. Correct any issues that are identified.
• Available Actions: Once validated, the available actions will be displayed.