Workflow Developer API

Run Developer Workflow

Start an active published workflow with idempotent retry semantics.

POST/developer/v1/workflows/{definition_id}/runs

Authorizations

Authorization

stringheaderrequired

Send your GenHealth credential as Bearer <YOUR_API_KEY>. This endpoint requires workflow:run for the authenticated organization.

Headers

Accept

stringheader

Response media type. Use application/json for the current API.

Parameters

definition_idrequired

stringpath

draft

booleanquery

Default: false

Request body

Send an application/json request body. This body is required.

WorkflowDeveloperRunTriggerRequest

idempotency_keyRequired opaque 16-256 character request identifier. Reuse it only for an exact retry of the same workflow version and trigger_data; generate a new UUID for a new logical run. Do not put PHI or credentials in this value.string

trigger_dataOptional manual-run input object supplied to the workflow trigger.object<string, any> | null

Responses

202Successful Response

WorkflowRunTriggerResponse

run_idstring

statusstring

422Validation Error

HTTPValidationError

detailarray<ValidationError>

Request example

curl --request POST \
  --url 'https://api.umpa.genhealth.ai/developer/v1/workflows/{definition_id}/runs?draft=false' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "idempotency_key": "string",
  "trigger_data": {
    "example_key": "string"
  }
}'

Response example

{
  "run_id": "string",
  "status": "open"
}

View OpenAPI document