API: Learn python with RAG and LLM


📖 To learn more, take a look at our complete API

📤 Example Request

  1. Generate an api key below👇

  2. Install node-fetch & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code and don't use direcly in the browser.

$ npm install node-fetch
$ export GOOEY_API_KEY=sk-xxxx
  1. Use this sample code to call the API.
    If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
import fetch from 'node-fetch';

const payload = {
  "search_query": "what are f-strings?",
  "documents": [
    "https://static.realpython.com/python-basics-sample-chapters.pdf",
    "https://edu.anarcho-copy.org/Programming%20Languages/Python/Automate%20the%20Boring%20Stuff%20with%20Python.pdf"
  ]
};

async function gooeyAPI() {
  const response = await fetch("https://api.gooey.ai/v2/doc-search?example_id=yec2t41o93m2", {
    method: "POST",
    headers: {
      "Authorization": "bearer " + process.env["GOOEY_API_KEY"],
      "Content-Type": "application/json",
    },
    body: JSON.stringify(payload),
  });

  if (!response.ok) {
    throw new Error(response.status);
  }

  const result = await response.json();
  console.log(response.status, result);
}

gooeyAPI();
  1. Generate an api key below👇

  2. Install requests & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code.

$ python3 -m pip install requests
$ export GOOEY_API_KEY=sk-xxxx
  1. Use this sample code to call the API.
    If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
import os
import requests

payload = {
    "search_query": "what are f-strings?",
    "documents": [
        "https://static.realpython.com/python-basics-sample-chapters.pdf",
        "https://edu.anarcho-copy.org/Programming%20Languages/Python/Automate%20the%20Boring%20Stuff%20with%20Python.pdf",
    ],
}

response = requests.post(
    "https://api.gooey.ai/v2/doc-search?example_id=yec2t41o93m2",
    headers={
        "Authorization": "bearer " + os.environ["GOOEY_API_KEY"],
    },
    json=payload,
)
assert response.ok, response.content

result = response.json()
print(response.status_code, result)
  1. Generate an api key below👇

  2. Install curl & add the GOOEY_API_KEY to your environment variables.
    Never store the api key in your code.

export GOOEY_API_KEY=sk-xxxx
  1. Run the following curl command in your terminal.
    If you encounter any issues, write to us at [email protected] and make sure to include the full curl command and the error message.
curl 'https://api.gooey.ai/v2/doc-search?example_id=yec2t41o93m2' \
  -H "Authorization: bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "search_query": "what are f-strings?",
  "documents": [
    "https://static.realpython.com/python-basics-sample-chapters.pdf",
    "https://edu.anarcho-copy.org/Programming%20Languages/Python/Automate%20the%20Boring%20Stuff%20with%20Python.pdf"
  ]
}'

🎁 Example Response

{4 Items
"id"
:
string
"vrkervmmcg2g"
"url"
:
string
"https://gooey.ai/doc-search/"
"created_at"
:
string
"2024-06-25T10:20:43.994127+00:00"
"output"
:
{4 Items
"output_text"
:
[1 Items
0
:
string
"F-strings, or formatted string literals, are a way"
]
"references"
:
[10 Items
0
:
{
}4 Items
1
:
{
}4 Items
2
:
{
}4 Items
3
:
{
}4 Items
4
:
{
}4 Items
5
:
{
}4 Items
6
:
{
}4 Items
7
:
{
}4 Items
8
:
{
}4 Items
9
:
{
}4 Items
]
"final_prompt"
:
string
"Search Result: [1] Title: """static.realpython.com"
"final_search_query"
:
string
"what are f-strings?"
}
}

Please Login to generate the $GOOEY_API_KEY