All pages

API reference

Get a link to a conversation's recording

GET /v1/conversations/{conversation_id}/recording

View as Markdown

A link to the audio that works for 5 minutes: a stereo Ogg file with the caller on the left and the agent on the right. Each key may ask for 60 a minute and 2,000 a day, and every link is recorded in the audit log. Needs recordings:read.

Parameters

Name In Type Required Description
conversation_id path string (uuid) Yes

Answer

200 with Recording.

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, or it has no recording.
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

Get a link to a recording
#!/bin/sh
# Get a link to a recording. The link works for five minutes, so download the audio straight away.
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/conversations/5f0c9a52-7d3e-4b1a-9c8f-6e2d4a0b3c1d/recording" \
  -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.