diff --git a/docs/novu.md b/docs/novu.md index 76b6f4f..2eb7ccf 100644 --- a/docs/novu.md +++ b/docs/novu.md @@ -12,19 +12,19 @@ Ensure the following environment variable is set: Otherwise, you can pass it in as an argument to the `Novu` constructor. -### How to Retrieve API Key on Novu.co +### How to Retrieve API Key -1. Open https://web.novu.co and sign in with your existing Novu account credentials (create a new account with your email address and a password or sign in with GitHub if you don't have an account yet) +1. Open https://web.novu.co and sign in with your existing Novu account credentials (create a new account with your email address and a password or sign in with GitHub if you don't have an account yet.) -2. Navigate to "Settings" +2. Navigate to "Settings": ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-08/bc87f12a-6f3b-48ef-af7f-b8f876baf912/ascreenshot.jpeg?tl_px=0,588&br_px=1120,1218&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=82,139) -3. Click "API Keys" +3. Click "API Keys": ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-08/b1036717-015e-491a-8e98-ad959c3d1e4e/user_cropped_screenshot.jpeg?tl_px=164,0&br_px=1284,630&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=262,83) -4. Click here to copy your API key to your clipboard +4. Click here to copy your API key to your clipboard: ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-08/43c0f398-5896-46dd-aa63-7c4418dc0ea1/user_cropped_screenshot.jpeg?tl_px=461,47&br_px=1581,677&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=452,199) @@ -43,13 +43,13 @@ The placeholders will be replaced with the actual values of the `payload` object To create a template, follow these steps: -1. Open https://web.novu.co and sign in with your Novu account credentials +1. Open https://web.novu.co and sign in with your Novu account credentials. -2. Click "Notifications" +2. Click "Notifications": ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-08/18f9a014-9f47-473f-9ef9-acc25d15ee29/ascreenshot.jpeg?tl_px=0,87&br_px=1120,717&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=61,139) -3. Click "Create Workflow" on the top-right +3. Click "Create Workflow" on the top-right: ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-08/07362d5c-1823-46ee-a6b2-17a363da74d9/user_cropped_screenshot.jpeg?tl_px=317,0&br_px=1437,404&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=415,82) diff --git a/docs/serpapi.md b/docs/serpapi.md new file mode 100644 index 0000000..c022f13 --- /dev/null +++ b/docs/serpapi.md @@ -0,0 +1,29 @@ +

SerpAPI Agentic Service

+ +## Intro + +[SerpApi][serpapi] is a service that provides a simple API to scrape Google search results. + +## Pre-requisites + +Ensure the following environment variable is set: + +- `SERPAPI_API_KEY` - API key for SerpAPI + +Otherwise, you can pass it in as an argument to the `SerpAPIClient` constructor. + +### How to Retrieve API Key + +1. Navigate to the [SerpAPI dashboard][serpapi-dashboard]. + +2. If you are not already logged in, you will be greeted by a signup screen. Click "Register" or "Sign in" depending on whether you already have an account. If you are registering, you will need to verify your email address and phone number before you can proceed. As of this writing, SerpAPI is free to use for up to 100 searches per month on the free plan, so depending on your use case, you may not need to upgrade to a paid plan to use this service. For more information, see [their pricing information][serpapi-pricing]. + +![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-09/33f3c072-91ab-4289-a2be-0bbdfcf5b48c/user_cropped_screenshot.jpeg?tl_px=369,0&br_px=1489,630&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=262,105) + +3. Inside the "Your Private API Key" box, click on the button to the right to copy the API key to your clipboard. You can also find your API key by clicking on "Api Key" in the left sidebar. + +![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-09/bcf72167-0023-4711-9cc0-719046e13714/user_cropped_screenshot.jpeg?tl_px=1265,547&br_px=2385,1177&sharp=0.8&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-labs-public.s3.us-east-2.amazonaws.com/images/watermarks/watermark_default.png&wat_pad=480,216) + +[serpapi]: https://serpapi.com +[serpapi-dashboard]: https://serpapi.com/dashboard +[serpapi-pricing]: https://serpapi.com/pricing