post/summarize

Generates a short English summary for a post.

Overview

Use this endpoint to summarize text in preview mode or to summarize a stored post and persist post_summary.

Authentication

Authentication behavior is partially confirmed. See Authentication.

Permissions

Authentication is required.

Endpoint

post/summarize

Purpose

Generates a summary and returns the result payload.

Method and path

POST /post/summarize

Headers

Header	Required	Description
X-Api-Key or X_API_KEY	yes	API key.
Content-Type	yes	application/json.

Request body

Preview mode:

Field	Type	Required	Description
intent	string	yes	Must be preview.
postData.post_text	string	yes	Text to summarize.

Normal mode:

Field	Type	Required	Description
projectId	integer	yes	Project identifier.
uuid	string	yes	Post UUID.

Example request

curl -X POST "$SIGNAL_API_BASE_URL/post/summarize" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "intent": "preview",
    "postData": {
      "post_text": "Example text to summarize."
    }
  }'

Example response

{
  "project_label": "example_project",
  "uuid": "abc123",
  "summary": "Short summary text",
  "updated": true
}

Notes

• In normal mode, the endpoint updates post_summary for the selected post.