Workflow Developer API

Get Workflow Outline

Read a compact node-and-edge outline before requesting larger graph details.

GET/developer/v1/workflows/{definition_id}/outline

Authorizations

Authorization

stringheaderrequired

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

Headers

Accept

stringheader

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

Parameters

definition_idrequired

stringpath

Responses

200Successful Response

WorkflowOutlineResponse

definition_idstring | null

edge_countinteger | null

edgesarray<object<string, any>>

editableboolean | null

errorstring | null

error_categorystring | null

node_countinteger | null

nodesarray<object<string, any>>

422Validation Error

HTTPValidationError

detailarray<ValidationError>

Request example

curl --request GET \
  --url 'https://api.umpa.genhealth.ai/developer/v1/workflows/{definition_id}/outline' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Accept: application/json'

Response example

{
  "definition_id": "string",
  "edge_count": 1,
  "edges": [
    {
      "example_key": "string"
    }
  ],
  "editable": true,
  "error": "string",
  "error_category": "string",
  "node_count": 1,
  "nodes": [
    {
      "example_key": "string"
    }
  ]
}

View OpenAPI document