API: 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://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/4fff4450-e6dc-11ed-a9f5-8e93953183bb/the_porsche_principle_press_information_08_29_2014_porsche_ag.pdf"
  ],
  "task_instructions": "Write an detailed and helpful summary of the above document:",
  "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", {
    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://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/4fff4450-e6dc-11ed-a9f5-8e93953183bb/the_porsche_principle_press_information_08_29_2014_porsche_ag.pdf"
    ],
    "task_instructions": "Write an detailed and helpful summary of the above document:",
    "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",
    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 \
  -H "Authorization: bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "documents": [
    "https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/4fff4450-e6dc-11ed-a9f5-8e93953183bb/the_porsche_principle_press_information_08_29_2014_porsche_ag.pdf"
  ],
  "task_instructions": "Write an detailed and helpful summary of the above document:",
  "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
"76g5628qoz4b"
"url"
:
string
"https://gooey.ai/doc-summary/"
"created_at"
:
string
"2024-12-17T08:12:18.186102+00:00"
"output"
:
{3 Items
"output_text"
:
[1 Items
0
:
string
"The document titled "The Porsche Principle" is a c"
]
"prompt_tree"
:
[1 Items
0
:
{
}2 Items
]
"final_prompt"
:
string
"[Document 1]: """ The Porsche Principle "
}
}

Please Login to generate the $GOOEY_API_KEY