Skip to main content

Summarization Async - GET Endpoint

Endpoint Overview​

Endpoint:
GET /api/companies/{companyCuid}/orchestrators/{orchestratorCuid}/summarization/{processCuid}

This endpoint allows you to retrieve the status and result of an asynchronous summarization process using the unique processCuid that was returned when the request was initially submitted.

Path Parameters​

ParameterDescriptionTypeRequiredExample
companyCuidUnique identifier for the company.StringYescompany123
orchestratorCuidUnique identifier for the orchestrator.StringYesorchestrator456
processCuidUnique identifier for the asynchronous summarization process.StringYes123e4567

Response​

The response will contain the status of the summarization process and, if finished, the generated summary.

{
  "status": "finished",
  "result": {
    "markdown": "**Nelson Mandela** served 27 years in prison before his release in 1990 by President F. W. de Klerk. Together, they negotiated an end to apartheid, leading to South Africa’s first multiracial election in 1994, where Mandela became president. His government promoted reconciliation, established the Truth and Reconciliation Commission, and maintained a liberal economic framework while implementing reforms in land, poverty reduction, and healthcare. Internationally, he mediated the Pan Am Flight 103 bombing trial and led the Non-Aligned Movement (1998–1999). Declining a second term, he was succeeded by Thabo Mbeki and later focused on poverty and HIV/AIDS through the Nelson Mandela Foundation.",
    "html": "<!DOCTYPE html><html><head><meta charset=\"UTF-8\"><title>Nelson Mandela Summary</title></head><body><p>Nelson Mandela served 27 years in prison before his release in 1990 by President F. W. de Klerk. Together, they negotiated an end to apartheid, leading to South Africa’s first multiracial election in 1994, where Mandela became president.</p><p>His government promoted reconciliation, established the Truth and Reconciliation Commission, and maintained a liberal economic framework while implementing reforms in land, poverty reduction, and healthcare.</p><p>Internationally, he mediated the Pan Am Flight 103 bombing trial and led the Non-Aligned Movement (1998–1999). Declining a second term, he was succeeded by Thabo Mbeki and later focused on poverty and HIV/AIDS through the Nelson Mandela Foundation.</p></body></html>"
  }
}