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, failed when the last try did not work, so ask again to try once more, 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 the first time it is asked for and then kept, and the first request after a newer message arrives writes it again, so reading one costs nothing. Summaries spend no AI actions.

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

Reference