Lewati ke konten utama
Ikhtisar API

Tiga endpoint proses dan dua probe kesehatan.

Markdown

Human Plugin dilayani melalui HTTP biasa pada port yang Anda konfigurasikan (default 8080). URL dasarnya adalah tempat Anda mengekspos container di dalam jaringan Anda, misalnya http://human-plugin.internal:8080.

MethodPathTujuan
POST/v1/processesBuat proses, dengan salah satu alur
GET/v1/processes/{id}Ambil proses
GET/v1/processes/{id}/selfieAmbil selfie
GET/health/liveLiveness. Lihat Kesehatan dan pemantauan
GET/health/readyKesiapan (ping database)

Tidak ada endpoint untuk menampilkan daftar, menghapus, atau mencari proses, dan tidak ada penerima webhook.

Aturan yang berlaku untuk setiap panggilan​

  • Tidak ada header autentikasi. Human Plugin tidak memvalidasi pemanggil. Batasi akses jaringan sebagai gantinya: lihat Jaringan dan keamanan.
  • Hanya JSON, dengan nama field camelCase.
  • Respons bersifat Cache-Control: no-store.
  • Error menggunakan satu envelope, {"message": "INVALID_REQUEST", "details": []}. Lihat Error dan percobaan ulang.
  • id adalah id proses Human Plugin. Simpan dari respons pembuatan: dengan id itulah Anda membaca proses di kemudian hari.

Urutan umum​

Selanjutnya: Buat proses.