Skip to the documentation
API

Read the summary of a thread

The short AI summary the reading pane shows above a thread.

GET/threads/{id}/summary

Runs the real call on your workspace.

GET /threads/{id}/summary

The short AI summary the reading pane shows above a thread.

Example

Needs threads:read. state is ready with the text in summary, pending while one is being written, or none when there is nothing to summarise, such as a thread holding a message that arrived encrypted.

curl
curl "$OE/threads/thr_7c1e4a90/summary" -H "$AUTH"
Response
{  "object": "thread_summary",  "threadId": "thr_7c1e4a90",  "state": "ready",  "summary": "Ada confirms the contract is signed and asks for the invoice by Friday."}

A summary is written once and kept, and written again when a new message arrives, so reading one costs nothing. Writing one spends one of the AI actions of the workspace.

A pending answer starts the writing, so ask again a few seconds later.

Reference