📖 To learn more, take a look at our complete API
📤 Example Request
Generate an api key below👇
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
- 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 = {
"documents": [
"https://ben10.fandom.com/wiki/Carl_Tennyson"
],
"task_instructions": "Read the full document above, and Write a Quiz with 5 fun Questions about the lead character (or show) in the JSON form below:\n1. title\n2. questions\n i. question\n ii. correct_answer\n iii. wrong_answers",
"merge_instructions": "- Summarise the documents into a single document that captures the essence of both.\n- Avoid simply concatenating the contents of the documents together. instead, include the most important information from each.\n- Include at max 5 questions in your response.\n- Don't include any information that is not in the documents.\n- Preserve the structure and formatting of the documents."
};
async function gooeyAPI() {
const response = await fetch("https://api.gooey.ai/v2/doc-summary?example_id=lmw9xzrf", {
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();
Generate an api key below👇
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
- 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 = {
"documents": ["https://ben10.fandom.com/wiki/Carl_Tennyson"],
"task_instructions": "Read the full document above, and Write a Quiz with 5 fun Questions about the lead character (or show) in the JSON form below:\n1. title\n2. questions\n i. question\n ii. correct_answer\n iii. wrong_answers",
"merge_instructions": "- Summarise the documents into a single document that captures the essence of both.\n- Avoid simply concatenating the contents of the documents together. instead, include the most important information from each.\n- Include at max 5 questions in your response.\n- Don't include any information that is not in the documents.\n- Preserve the structure and formatting of the documents.",
}
response = requests.post(
"https://api.gooey.ai/v2/doc-summary?example_id=lmw9xzrf",
headers={
"Authorization": "bearer " + os.environ["GOOEY_API_KEY"],
},
json=payload,
)
assert response.ok, response.content
result = response.json()
print(response.status_code, result)
Generate an api key below👇
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
- 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-summary?example_id=lmw9xzrf' \
-H "Authorization: bearer $GOOEY_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"documents": [
"https://ben10.fandom.com/wiki/Carl_Tennyson"
],
"task_instructions": "Read the full document above, and Write a Quiz with 5 fun Questions about the lead character (or show) in the JSON form below:\n1. title\n2. questions\n i. question\n ii. correct_answer\n iii. wrong_answers",
"merge_instructions": "- Summarise the documents into a single document that captures the essence of both.\n- Avoid simply concatenating the contents of the documents together. instead, include the most important information from each.\n- Include at max 5 questions in your response.\n- Don'"'"'t include any information that is not in the documents.\n- Preserve the structure and formatting of the documents."
}'
🎁 Example Response
{4 Items"url":
string
"https://gooey.ai/doc-summary/"
"created_at":
string
"2024-01-18T16:24:37.943347+00:00"
"output":
{3 Items"output_text":
[1 Items0:
string
"```json
{
"title": "Ben 10 Ultimate Quiz",
"qu…"
] "final_prompt":
string
"[Document 1]: """
```json
{
"title": "Ben 10 Ult…"
} } Please Login to generate the $GOOEY_API_KEY