Summarization Async - Endpoint

Endpoint Overview

Endpoint:
POST /api/companies/{companyCuid}/orchestrators/{orchestratorCuid}/summarization-async

This endpoint asynchronously processes a text summarization request and provides a process ID to check the status and result later. checkout the result using the endpoint presented Here.

---

Request Body

The request body includes the text to summarize, the summary type, and an optional external reference.

Field	Description	Type	Required	Example
content	The content to summarize.	Object	Yes	{ "text": "Mandela served 27 years in prison, split between Robben Island..." }
type	The type of summary requested.	String	Yes	"detailed_summary"
external_ref	Optional external reference ID to track the request.	String	No	"1234-abcd-56ef-7891"
external_metadata	Optional metadata related to the request. Can be used for tracking or providing context.	Object	No	{ "user_id": "98765", "session_id": "abcd1234" }

Supported type values

• factual_summary
• detailed_summary
• technical_summary
• custom_summary

---

Example Request

{
  "content": {
    "text": "Mandela served 27 years in prison, split between Robben Island, Pollsmoor Prison, and Victor Verster Prison..."
  },
  "type": "detailed_summary",
  "external_ref": "1234-abcd-56ef-7891",
  "external_metadata": {
    "user_id": "98765",
    "session_id": "abcd1234"
  }
}

---

Response

The response includes a process cuid, which is a unique identifier for the asynchronous summarization process. Use this ID to check the status of the process and retrieve the summary.

Field	Description	Type	Example
process_cuid	unique process identifier	String	"123e4567"

---

Example Response

{
  "process_cuid": "123e4567"
}

---