मुख्य सामग्री पर जाएं
API अवलोकन

तीन process endpoints और दो health probes।

Markdown

Human Plugin सादे HTTP पर उस port पर चलता है जिसे आप configure करते हैं (डिफ़ॉल्ट 8080)। base URL वही है जहाँ आप container को अपने network के भीतर expose करते हैं, उदाहरण के लिए http://human-plugin.internal:8080।

MethodPathउद्देश्य
POST/v1/processesProcess बनाएँ, किसी एक flow के साथ
GET/v1/processes/{id}Process प्राप्त करें
GET/v1/processes/{id}/selfieSelfie प्राप्त करें
GET/health/liveLiveness। देखें Health और monitoring
GET/health/readyReadiness (database ping)

processes की सूची बनाने, उन्हें हटाने या खोजने के लिए कोई endpoint नहीं है, और कोई webhook receiver भी नहीं है।

हर call पर लागू होने वाले नियम​

  • कोई authentication header नहीं। Human Plugin callers को validate नहीं करता। इसके बजाय network access को सीमित करें: देखें Networking और सुरक्षा।
  • केवल JSON, camelCase field names के साथ।
  • Responses Cache-Control: no-store के साथ आते हैं।
  • Errors एक ही envelope का उपयोग करती हैं, {"message": "INVALID_REQUEST", "details": []}। देखें Errors और retries।
  • id Human Plugin की process id है। इसे create के जवाब से सहेजकर रखें: बाद में process को इसी से पढ़ा जाता है।

सामान्य क्रम​

आगे: Process बनाएँ।