Integrations

Dokumentasi API dan SDK ScreenApp

API ScreenApp memungkinkan Anda untuk secara otomatis mentranskripsi, meringkas, dan menganalisis konten video dan audio

Pilih versi API yang tepat

Aplikasi saat ini memakai API /app/api/v1. Integrasi lama dapat memakai layanan terpisah api.screenapp.io/v2. Endpoint, kredensial, dan alur unggahnya tidak bisa saling menggantikan.

Sebelum mengubah integrasi yang ada, pastikan base URL dan generasi akunnya. Untuk integrasi lama, lihat referensi v2 dan konfirmasi dukungan migrasi dengan ScreenApp.

Buat kunci di aplikasi saat ini

Buka Settings > API di aplikasi saat ini. Buat kunci bernama dengan cakupan izin sesempit mungkin dan simpan saat ditampilkan. Rahasiakan kunci tersebut dan cabut jika bocor. Periksa apakah kunci terkait ruang pribadi atau tim.

Cakupan publik saat ini adalah files:read and files:upload.

Baca konteks akun Anda

Atur SCREENAPP_API_KEY secara privat di environment Anda. Jangan menaruhnya di HTML sisi klien atau meng-commit-nya ke repositori.

curl --fail-with-body "https://screenapp.io/app/api/v1/me"   -H "x-api-key: $SCREENAPP_API_KEY"

Unggah file

Gunakan kunci dengan izin unggah. Ganti nama file lokal dengan file Anda sendiri.

curl --fail-with-body "https://screenapp.io/app/api/v1/videos"   -H "x-api-key: $SCREENAPP_API_KEY"   -F "file=@recording.mp4"

Respons berisi ID file baru. Pemrosesan berlanjut di latar belakang. Panggil GET /app/api/v1/videos/{id} berkala sampai transcriptStatus bernilai ready, lalu minta GET /app/api/v1/videos/{id}/transcript.

Unggahan langsung melalui API saat ini memiliki batas body 512 MB. Ini hanya batas API; unggahan di aplikasi tidak memiliki batas ukuran file yang ditetapkan. Endpoint videos yang sama juga menerima objek JSON berisi url publik sebagai ganti mengunggah file lokal.

Baca rekaman

  • GET /app/api/v1/videos menampilkan daftar rekaman di ruang kunci.
  • GET /app/api/v1/videos/{id} mengembalikan status dan metadata.
  • GET /app/api/v1/videos/{id}/transcript mengembalikan transkrip saat sudah siap.

Gunakan izin baca untuk permintaan ini. Kunci yang hilang atau tidak valid mengembalikan 401, cakupan yang kurang mengembalikan 403, dan pembatasan laju mengembalikan 429. Ikuti Retry-After jika dikirim. Transkrip yang diminta sebelum siap bisa mengembalikan 409.

Sematkan perekam

Penyematan punya pengaturan terpisah dan pembatasan domain. Ikuti panduan menyematkan perekam. Jangan gunakan kunci REST privat sebagai token sematan.

Contoh ini menjelaskan kontrak API saat ini. Verifikasi di akun dan environment yang akan Anda pakai sebelum mengganti integrasi lama yang masih berjalan.