Skip to main content
API overview

Three process endpoints and two health probes.

Markdown

Human Plugin is served over plain HTTP on the port you configure (default 8080). The base URL is wherever you expose the container inside your network, for example http://human-plugin.internal:8080.

MethodPathPurpose
POST/v1/processesCreate a process, with one of the flows
GET/v1/processes/{id}Get a process
GET/v1/processes/{id}/selfieGet the selfie
GET/health/liveLiveness. See Health and monitoring
GET/health/readyReadiness (database ping)

There is no endpoint to list, delete or search processes, and no webhook receiver.

Rules that apply to every call​

  • No authentication header. Human Plugin does not validate callers. Restrict network access instead: see Networking and security.
  • JSON only, with camelCase field names.
  • Responses are Cache-Control: no-store.
  • Errors use one envelope, {"message": "INVALID_REQUEST", "details": []}. See Errors and retries.
  • id is Human Plugin's process id. Keep it from the create: it is how you read the process later.

Typical sequence​

Next: Create a process.