All pages

API reference

Follow a call's transcript live

GET /v1/conversations/{conversation_id}/live

View as Markdown

The lines said on a call since after, as they are said. Answers as soon as there is a line after after, or after wait seconds with none; send next_after back as after and ask again, until ended is true. Lines are kept for a day: after that, read the conversation's transcript. Needs transcripts:read.

Parameters

Name In Type Required Description
conversation_id path string (uuid) Yes
after query integer No The last seq you have read.
wait query integer No How long to wait for a line, in seconds.

Answer

200 with LiveTranscript.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
404 This key reaches no such conversation.
409 A chat or a WhatsApp conversation has no live transcript.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Follow a call's transcript live
#!/bin/sh
# Follow a call's transcript live. Send next_after back as after, and ask again until ended is true.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/conversations/5b7d9f1b-3d5f-4b7d-a9f1-b3d5f7b9dbfd/live?after=0&wait=20" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.