Summary

Summarise a document using AI

Create a AI (GPT-4) generated summary of the provided document.

POSThttps://api.tendocs.com/ai/v1/tasks/summary

Body

application/json

document*object

File to be summarised.

configuration*object

Configuration Settings

Response

200202403404500

Success

Body

application/json

Type*string

The type of summary provided

Example: "Summary"

Content*string

Summary of the document

Example: "Summary of the document provided."

Length*number

The length of the summary

Example: 300

Request

JavaScriptCurlPython

const response = await fetch('https://api.tendocs.com/ai/v1/tasks/summary', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "document": {
        "$content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
        "$content": "UEsDBBQAAAgIAJMrVV...[[Base64 Encoded File]]"
      },
      "configuration": {
        "MaximumWordCount": 300,
        "Keys": {
          "example_key1": "example_key_value1",
          "example_key2": "example_key_value2"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "Type": "Summary",
  "Content": "Summary of the document provided.",
  "Length": 300
}