Get Form Filling Session Recording

Get presigned URLs for Form filling session recordings for streaming or download

GET /api/v1/ambient/session/{ambient_session_id}/recording

cURL

cURL

curl --request GET \
  --url https://sdp.suki.ai/api/v1/ambient/session/<ambient_session_id>/recording?download=<download> \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --header 'sdp_provider_id: <sdp_provider_id>'

200

{
  "recordings": [
    {
      "recording_id": "01KFJZTJWZH28GRHQXVCGW4Y47",
      "presigned_url": "https://storage.googleapis.com/...",
      "expires_at": 1738765432,
      "sequence_number": 1
    }
  ],
  "is_streamable": true
}

Use this endpoint to get presigned URLs for all recordings for a Form filling session.

Pass the Form filling ambient_session_id from Create Form filling session in the path.

Use the ambient_session_id from Create Form filling session. It is not the same value as an Create ambient session, even though both fields use the name ambient_session_id.

For how to use presigned URLs after retrieval, refer to Ambient session recordings.

Use the download query parameter to control the URL type:

• If download=true, the URL is for downloading the full file.
• If download=false or omitted, the URL supports streaming with range requests.

Code examples

Python

import requests

# Form filling ambient_session_id from POST /api/v1/form-filling/session/create
form_filling_session_id = "123dfg-456dfg-789dfg-012dfg"
url = f"https://sdp.suki-stage.com/api/v1/ambient/session/{form_filling_session_id}/recording"

headers = {
    "sdp_suki_token": "<sdp_suki_token>",
    "sdp_provider_id": "<sdp_provider_id>",
}

# For streaming URLs (default)
response = requests.get(url, headers=headers)

# For download-only URLs
# response = requests.get(url, headers=headers, params={"download": True})

if response.status_code == 200:
    data = response.json()
    print(f"Streamable: {data.get('is_streamable')}")
    for rec in data.get("recordings", []):
        print(f"Recording ID: {rec.get('recording_id')}")
        print(f"Presigned URL: {rec.get('presigned_url')}")
        print(f"Expires at: {rec.get('expires_at')}")
        print(f"Sequence: {rec.get('sequence_number')}")
        print("---")
else:
    print(f"Failed to get recording URLs: {response.status_code}")
    print(response.json())

TypeScript

// Form filling ambient_session_id from POST /api/v1/form-filling/session/create
const formFillingSessionId = '123dfg-456dfg-789dfg-012dfg';

const response = await fetch(
  `https://sdp.suki-stage.com/api/v1/ambient/session/${formFillingSessionId}/recording`,
  {
    headers: {
      sdp_suki_token: '<sdp_suki_token>',
      sdp_provider_id: '<sdp_provider_id>',
    },
  },
);

// For download-only URLs, append ?download=true

if (response.ok) {
  const data = await response.json();
  console.log('Streamable:', data.is_streamable);
  data.recordings?.forEach((rec: {
    recording_id?: string;
    presigned_url?: string;
    expires_at?: number;
    sequence_number?: number;
  }) => {
    console.log('Recording ID:', rec.recording_id);
    console.log('Presigned URL:', rec.presigned_url);
    console.log('Expires at:', rec.expires_at);
    console.log('Sequence:', rec.sequence_number);
    console.log('---');
  });
} else {
  const error = await response.json();
  console.error(`Failed to get recording URLs: ${response.status}`, error);
}

Authorizations

sdp_suki_token · string · header · required

Suki access token (suki_token) from Login or Register. Expires after one hour.

Headers

sdp_provider_id · string

Optional for standard partners.

Required for:

• Bearer authentication. Use the same provider_id returned by the Login or Register API.
• Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Example:

"provider-123"

Path Parameters

ambient_session_id · string · required

UUID for the ambient session. Use the ambient_session_id returned from Create Ambient Session, or the UUID you supplied in that request.

Query Parameters

download · boolean

If true, returns download-only URLs; if false or omitted, URLs support streaming with Range requests.

Response

200

application/json

Request succeeded.

Response body for the /session/{ambient_session_id}/recording endpoint

recordings · object[]

List of recordings with presigned URLs for the ambient session.

Show child attributes

is_streamable · boolean

Whether the returned URLs support streaming with Range requests.

Example:

true