Skip to content

Speakr is a personal, self-hosted web application designed for transcribing audio recordings

Python

Expose audio_duration, durations, folder, events, and deletion_exempt on api/v1 recording endpoints

Murtaza Nasir0b2eda11e9f3
diff --git a/src/api/api_v1.py b/src/api/api_v1.py
index 998c6523..9a07e712 100644
--- a/src/api/api_v1.py
+++ b/src/api/api_v1.py
@@ -667,6 +667,7 @@ def list_recordings():
'title': r.title,
'status': r.status,
'created_at': r.created_at.isoformat() if r.created_at else None,
+ 'completed_at': r.completed_at.isoformat() if r.completed_at else None,
'meeting_date': r.meeting_date.isoformat() if r.meeting_date else None,
'file_size': r.file_size,
'original_filename': r.original_filename,
@@ -674,8 +675,15 @@ def list_recordings():
'is_inbox': r.is_inbox,
'is_highlighted': r.is_highlighted,
'audio_available': r.audio_deleted_at is None,
+ 'audio_duration': r.get_audio_duration(),
'has_transcription': bool(r.transcription),
'has_summary': bool(r.summary),
+ 'processing_time_seconds': r.processing_time_seconds,
+ 'transcription_duration_seconds': r.transcription_duration_seconds,
+ 'summarization_duration_seconds': r.summarization_duration_seconds,
+ 'folder_id': r.folder_id,
+ 'folder': {'id': r.folder.id, 'name': r.folder.name} if r.folder else None,
+ 'deletion_exempt': r.deletion_exempt,
'error_message': r.error_message if r.status == 'FAILED' else None,
'tags': [{'id': t.id, 'name': t.name, 'color': t.color} for t in r.tags]
})
@@ -733,7 +741,14 @@ def get_recording(recording_id):
'is_inbox': recording.is_inbox,
'is_highlighted': recording.is_highlighted,
'audio_available': recording.audio_deleted_at is None,
+ 'audio_duration': recording.get_audio_duration(),
'processing_time_seconds': recording.processing_time_seconds,
+ 'transcription_duration_seconds': recording.transcription_duration_seconds,
+ 'summarization_duration_seconds': recording.summarization_duration_seconds,
+ 'folder_id': recording.folder_id,
+ 'folder': {'id': recording.folder.id, 'name': recording.folder.name} if recording.folder else None,
+ 'deletion_exempt': recording.deletion_exempt,
+ 'events': [e.to_dict() for e in recording.events] if hasattr(recording, 'events') else [],
'error_message': recording.error_message if recording.status == 'FAILED' else None,
'tags': [{'id': t.id, 'name': t.name, 'color': t.color} for t in recording.tags],
'duplicate_info': recording.get_duplicate_info()
diff --git a/tests/test_api_v1_parity.py b/tests/test_api_v1_parity.py
new file mode 100644
index 00000000..875b42bb
--- /dev/null
+++ b/tests/test_api_v1_parity.py
@@ -0,0 +1,149 @@
+#!/usr/bin/env python3
+"""
+Smoke test for issue #274: /api/v1/recordings and /api/v1/recordings/{id}
+should expose audio_duration, durations, folder, events, and deletion_exempt.
+
+Run with: docker exec speakr-dev python /app/tests/test_api_v1_parity.py
+"""
+
+import secrets
+import sys
+import uuid
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from src.app import app, db
+from src.models import User, Recording, APIToken
+from src.models.organization import Folder
+from src.utils.token_auth import hash_token
+
+
+PASSED = 0
+FAILED = 0
+
+
+def run(name, func):
+ global PASSED, FAILED
+ try:
+ func()
+ print(f" ✓ {name}")
+ PASSED += 1
+ except AssertionError as e:
+ print(f" ✗ {name}: {e}")
+ FAILED += 1
+ except Exception as e:
+ print(f" ✗ {name}: EXCEPTION - {e}")
+ FAILED += 1
+
+
+def setup_user_and_recording():
+ suffix = uuid.uuid4().hex[:10]
+ user = User(
+ username=f"v1parity_{suffix}",
+ email=f"v1parity_{suffix}@test.local",
+ password="x",
+ )
+ db.session.add(user)
+ db.session.flush()
+ folder = Folder(name=f"folder_{suffix}", user_id=user.id)
+ db.session.add(folder)
+ db.session.flush()
+
+ rec = Recording(
+ audio_path="/tmp/dummy.wav",
+ original_filename="dummy.wav",
+ title="parity test",
+ status="COMPLETED",
+ user_id=user.id,
+ folder_id=folder.id,
+ deletion_exempt=True,
+ transcription_duration_seconds=42,
+ summarization_duration_seconds=7,
+ )
+ db.session.add(rec)
+ db.session.flush()
+
+ plaintext = f"v1parity-{secrets.token_urlsafe(16)}"
+ token = APIToken(
+ user_id=user.id,
+ token_hash=hash_token(plaintext),
+ name="v1parity-token",
+ )
+ db.session.add(token)
+ db.session.commit()
+ return user, rec, folder, plaintext
+
+
+REQUIRED_DETAIL_FIELDS = {
+ "audio_duration",
+ "transcription_duration_seconds",
+ "summarization_duration_seconds",
+ "folder_id",
+ "folder",
+ "deletion_exempt",
+ "events",
+}
+
+REQUIRED_LIST_FIELDS = {
+ "audio_duration",
+ "transcription_duration_seconds",
+ "summarization_duration_seconds",
+ "folder_id",
+ "folder",
+ "deletion_exempt",
+ "completed_at",
+ "processing_time_seconds",
+}
+
+
+def test_detail_has_all_new_fields():
+ with app.app_context():
+ user, rec, folder, token = setup_user_and_recording()
+ client = app.test_client()
+ resp = client.get(
+ f"/api/v1/recordings/{rec.id}",
+ headers={"X-API-Token": token},
+ )
+ assert resp.status_code == 200, f"unexpected status {resp.status_code}: {resp.data!r}"
+ body = resp.get_json()
+ missing = REQUIRED_DETAIL_FIELDS - set(body.keys())
+ assert not missing, f"detail endpoint missing fields: {missing}"
+ # audio file is /tmp/dummy.wav and doesn't exist → audio_duration is None.
+ assert body["audio_duration"] is None
+ assert body["transcription_duration_seconds"] == 42
+ assert body["summarization_duration_seconds"] == 7
+ assert body["folder_id"] == folder.id
+ assert body["folder"] == {"id": folder.id, "name": folder.name}
+ assert body["deletion_exempt"] is True
+ assert body["events"] == []
+
+
+def test_list_has_all_new_fields():
+ with app.app_context():
+ user, rec, folder, token = setup_user_and_recording()
+ client = app.test_client()
+ resp = client.get(
+ "/api/v1/recordings",
+ headers={"X-API-Token": token},
+ )
+ assert resp.status_code == 200, f"unexpected status {resp.status_code}: {resp.data!r}"
+ body = resp.get_json()
+ assert body.get("recordings"), f"no recordings in response: {body!r}"
+ # Find our recording in the list (other tests may have added rows).
+ ours = next((r for r in body["recordings"] if r["id"] == rec.id), None)
+ assert ours, f"new recording {rec.id} missing from list"
+ missing = REQUIRED_LIST_FIELDS - set(ours.keys())
+ assert not missing, f"list item missing fields: {missing}"
+
+
+def main():
+ print("=== Issue #274: API v1 parity ===\n")
+ run("detail endpoint exposes new fields", test_detail_has_all_new_fields)
+ run("list endpoint exposes new fields", test_list_has_all_new_fields)
+ print(f"\nResults: {PASSED} passed, {FAILED} failed")
+ return 0 if FAILED == 0 else 1
+
+
+if __name__ == "__main__":
+ sys.exit(main())