Recap

Manually trigger recap for a call

post/v1/recap/calls/{call_id}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/recap/calls/{call_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

call_idstring required

Request body

pack_idstring
call_duration_snumber
call_direction'inbound' | 'outbound'
customer_namestring
language'en' | 'fr' | 'es' | 'de' | 'hi'

Language for the Recap output; this does not transcribe audio.

crm_fieldsobject

Response

Recap job accepted

objectstring
call_idstring
pack_idstring
status'pending' | 'processing' | 'complete' | 'failed'
call_duration_snumber nullable
created_atinteger
completed_atinteger nullable
sourcestring nullable

Call origin, for example external.

headlinestring nullable

Best available summary headline for list and tracking views.

customer_namestring nullable
call_direction'inbound' | 'outbound' nullable

Example response

{
  "object": "recap.call"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.