---
title: "Summarize Content"
description: "Create concise summaries of lengthy content. Choose from different \nsummary lengths and formats including bullet points.\n\n**Note**: This endpoint is deployed on Cloudflare Workers at `https://ai-notes.customerconnects.app`\n"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › AI

`POST /api/notes/summarize`

Create concise summaries of lengthy content. Choose from different 
summary lengths and formats including bullet points.

**Note**: This endpoint is deployed on Cloudflare Workers at `https://ai-notes.customerconnects.app`

## Authentication

Requires one of the following:

- `NoAuth`
- `ApiKeyAuth`, apiKey, in header, header `X-API-Key`, format `API_KEY`

## Header parameters

- `X-Workspace-Id` (`post/api/notes/summarize.header.X-Workspace-Id`; string, required) — Workspace ID for data isolation

## Request body

_Required._

- `workspaceId` (`post/api/notes/summarize.workspaceId`; integer, required)
  - example `12345`
- `content` (`post/api/notes/summarize.content`; string, required)
  - example `"Artificial Intelligence has revolutionized customer service..."`
- `summaryLength` (`post/api/notes/summarize.summaryLength`; string, optional)
  - one of `"short"`, `"medium"`, `"long"`, `"bullet"`; default `"medium"`; example `"bullet"`
- `noteId` (`post/api/notes/summarize.noteId`; string, optional)
  - example `"note_123"`
- `options` (`post/api/notes/summarize.options`; object, optional)

## Example requests

### Basic summarization

```json
{
  "workspaceId": 15213,
  "content": "Artificial Intelligence has revolutionized customer service by enabling instant responses, 24/7 availability, and personalized interactions.",
  "summaryLength": "medium"
}
```

### Bullet point summary

```json
{
  "workspaceId": 15213,
  "content": "Long article content here...",
  "summaryLength": "bullet"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.channelautomation.com/api/notes/summarize \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: 15213' \
  --data '
{
  "workspaceId": 15213,
  "content": "Artificial Intelligence has revolutionized customer service by enabling instant responses, 24/7 availability, and personalized interactions.",
  "summaryLength": "medium"
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/notes/summarize';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'X-Workspace-Id': '15213'},
  body: JSON.stringify({
    workspaceId: 15213,
    content: 'Artificial Intelligence has revolutionized customer service by enabling instant responses, 24/7 availability, and personalized interactions.',
    summaryLength: 'medium'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/notes/summarize"

payload = {
    "workspaceId": 15213,
    "content": "Artificial Intelligence has revolutionized customer service by enabling instant responses, 24/7 availability, and personalized interactions.",
    "summaryLength": "medium"
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "15213"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Content summarized successfully

#### Example

```json
{
  "success": true,
  "original": "Artificial Intelligence has revolutionized customer service...",
  "summary": "• AI enables instant responses and 24/7 customer service availability...",
  "summaryLength": "bullet",
  "metadata": {
    "tokensUsed": 145,
    "processingTime": 3421,
    "model": "gpt-4o",
    "compressionRatio": 3.2
  }
}
```

- `success` (`post/api/notes/summarize.response.200.success`; boolean, optional)
  - example `true`
- `original` (`post/api/notes/summarize.response.200.original`; string, optional)
  - example `"Artificial Intelligence has revolutionized customer service..."`
- `summary` (`post/api/notes/summarize.response.200.summary`; string, optional)
  - example `"• AI enables instant responses and 24/7 customer service availability..."`
- `summaryLength` (`post/api/notes/summarize.response.200.summaryLength`; string, optional)
  - example `"bullet"`
- `metadata` (`post/api/notes/summarize.response.200.metadata`; object, optional)
  - `tokensUsed` (`post/api/notes/summarize.response.200.metadata.tokensUsed`; integer, optional)
    - example `145`
  - `processingTime` (`post/api/notes/summarize.response.200.metadata.processingTime`; integer, optional)
    - example `3421`
  - `model` (`post/api/notes/summarize.response.200.metadata.model`; string, optional)
    - example `"gpt-4o"`
  - `compressionRatio` (`post/api/notes/summarize.response.200.metadata.compressionRatio`; number, optional)
    - example `3.2`


Source: https://developer.channelautomations.com/api/post-api-notes-summarize/index.md