v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Create a new ai summary.

Creates a new ai summary and returns the created ai summary's details.

post/aisummaries

Request body

on_end_flow_idstring required

The ID of the flow to be executed when the ai summary ends.

reference_type'' | 'call' | 'conference' | 'transcribe' | 'recording' required

Type of reference for the AI summary.

reference_idstring required

The ID of the reference for the ai summary.

languagestring required

The language of the ai summary.

Example request

{
  "reference_type": "call"
}

Response

Details of the created ai summary.

idstring uuid

The unique identifier of the summary.

customer_idstring uuid

The unique identifier of the associated customer. Returned from the GET /customers response.

activeflow_idstring uuid

The unique identifier of the activeflow. Returned from the GET /activeflows response.

on_end_flow_idstring uuid

The unique identifier of the flow to execute when the summary completes. Returned from the POST /flows or GET /flows response.

reference_type'' | 'call' | 'conference' | 'transcribe' | 'recording'

Type of reference for the AI summary.

reference_idstring uuid

The unique identifier of the referenced resource. The actual resource type is determined by reference_type. Returned from the corresponding resource endpoint.

status'' | 'progressing' | 'done'

Status of the AI summary generation.

languagestring

Language used for the AI summary.

contentstring

Content of the summary.

tm_createstring date-time

Timestamp when the summary was created.

tm_updatestring date-time

Timestamp when the summary was last updated.

tm_deletestring date-time

Timestamp when the summary was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  "on_end_flow_id": "550e8400-e29b-41d4-a716-446655440000",
  "reference_type": "call",
  "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "progressing",
  "language": "en-US",
  "content": "The customer called to inquire about their account balance and was assisted by the support agent.",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}