API: Opportunity.org Summarize Large Files with GPT


📖 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 = {
  "documents": [
    "https://opportunity.org/content/News/News/Media%20Coverage/2024-bloomberg-feature.pdf",
    "https://www.japantimes.co.jp/business/2024/06/15/tech/ai-revolution-farming/",
    "https://blog.gooey.ai/global-language-understanding-for-ais"
  ],
  "task_instructions": "Write an detailed and helpful summary combining information from these 3 documents to tell the Story of how Gooey.AI supported the solution for Opportunity.org to help farmers. \n\nPlease provide citations to the original documents \n\nPlease use convincing language and take referenes from. the Gooey.AI background on \n",
  "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- 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=7hws3luk5bjk", {
    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 = {
    "documents": [
        "https://opportunity.org/content/News/News/Media%20Coverage/2024-bloomberg-feature.pdf",
        "https://www.japantimes.co.jp/business/2024/06/15/tech/ai-revolution-farming/",
        "https://blog.gooey.ai/global-language-understanding-for-ais",
    ],
    "task_instructions": "Write an detailed and helpful summary combining information from these 3 documents to tell the Story of how Gooey.AI supported the solution for Opportunity.org to help farmers. \n\nPlease provide citations to the original documents \n\nPlease use convincing language and take referenes from. the Gooey.AI background on \n",
    "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- 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=7hws3luk5bjk",
    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-summary?example_id=7hws3luk5bjk' \
  -H "Authorization: bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "documents": [
    "https://opportunity.org/content/News/News/Media%20Coverage/2024-bloomberg-feature.pdf",
    "https://www.japantimes.co.jp/business/2024/06/15/tech/ai-revolution-farming/",
    "https://blog.gooey.ai/global-language-understanding-for-ais"
  ],
  "task_instructions": "Write an detailed and helpful summary combining information from these 3 documents to tell the Story of how Gooey.AI supported the solution for Opportunity.org to help farmers. \n\nPlease provide citations to the original documents \n\nPlease use convincing language and take referenes from. the Gooey.AI background on \n",
  "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- Don'"'"'t include any information that is not in the documents.\n- Preserve the structure and formatting of the documents."
}'

🎁 Example Response

{4 Items
"id"
:
string
"ggcs2apkl07k"
"url"
:
string
"https://gooey.ai/doc-summary/"
"created_at"
:
string
"2024-08-07T17:38:43.336158+00:00"
"output"
:
{3 Items
"output_text"
:
[1 Items
0
:
string
"[Document 3]: """ Summary: Gooey.AI, in collabora"
]
"prompt_tree"
:
[1 Items
0
:
{
}2 Items
]
"final_prompt"
:
string
"[Document 1]: """ Based on the information from th"
}
}

Please Login to generate the $GOOEY_API_KEY