Skip to main content

Document and Report Summarization

Scenario: Summarize long documents uploaded to cloud storage.

How Tess API Helps: Tess can quickly summarize lengthy documents, making it easier to extract key insights and share concise summaries with your team.

Workflow​

  1. Trigger: A new file is uploaded to cloud storage (e.g., Google Drive).
  2. Action: Upload the file to Tess using the /files (POST) endpoint and obtain the file ID.
  3. Action: Execute a summarization agent via /agents/{id}/execute, attaching the file_id and setting wait_execution=true.
  4. Action: Save the summary to another location or send it by email.

Example Tess API Requests​

1. Upload the File to Tess​

POST /files
Content-Type: multipart/form-data
Authorization: Bearer YOUR_API_KEY

file=@/path/to/document.pdf

Response Example:

{
  "file_id": "abc123def456"
}

2. Request a Summary from Tess Agent​

POST /agents/{agent_id}/execute?wait_execution=true
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "temperature": "1",
  "model": "tess-5",
  "messages": [
    { "role": "user", "content": "Summarize the attached document." }
  ],
  "tools": "no-tools",
  "wait_execution": true,
  "file_ids": [123456]
}

Response Example:

{
  "template_id": "8794",
  "responses": [
    {
      "id": 4773337,
      "status": "succeeded",
      "input": "Summarize the attached document.",
      "output": "This document provides an overview of...",
      "credits": 0.000337,
      "root_id": 4773337,
      "created_at": "2025-01-05T19:35:21.000000Z",
      "updated_at": "2025-01-05T19:35:23.000000Z",
      "template_id": 8794
    }
  ]
}

3. Save or Send the Summary​

Use your preferred method (e.g., Google Drive API, email API) to store or share the summary.

Benefits​

  • Accelerates understanding of lengthy documents
  • Enables quick sharing of key points
  • Reduces manual reading time

Endpoints Used​

  • POST /files
  • POST /agents/{id}/execute

Tip: Automate the entire process using tools like Zapier or Make for seamless document handling and summarization!